Project

General

Profile

1
--
2
-- PostgreSQL database dump
3
--
4

    
5
SET statement_timeout = 0;
6
SET lock_timeout = 0;
7
SET client_encoding = 'UTF8';
8
SET standard_conforming_strings = on;
9
SET check_function_bodies = false;
10
SET client_min_messages = warning;
11

    
12
--
13
-- Name: util; Type: SCHEMA; Schema: -; Owner: -
14
--
15

    
16
CREATE SCHEMA util;
17

    
18

    
19
--
20
-- Name: SCHEMA util; Type: COMMENT; Schema: -; Owner: -
21
--
22

    
23
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

    
26
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
';
28

    
29

    
30
SET search_path = util, pg_catalog;
31

    
32
--
33
-- Name: col_cast; Type: TYPE; Schema: util; Owner: -
34
--
35

    
36
CREATE TYPE col_cast AS (
37
	col_name text,
38
	type regtype
39
);
40

    
41

    
42
--
43
-- Name: col_ref; Type: TYPE; Schema: util; Owner: -
44
--
45

    
46
CREATE TYPE col_ref AS (
47
	table_ regclass,
48
	name text
49
);
50

    
51

    
52
--
53
-- Name: compass_dir; Type: TYPE; Schema: util; Owner: -
54
--
55

    
56
CREATE TYPE compass_dir AS ENUM (
57
    'N',
58
    'E',
59
    'S',
60
    'W'
61
);
62

    
63

    
64
--
65
-- Name: datatype; Type: TYPE; Schema: util; Owner: -
66
--
67

    
68
CREATE TYPE datatype AS ENUM (
69
    'str',
70
    'float'
71
);
72

    
73

    
74
--
75
-- Name: %==(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
76
--
77

    
78
CREATE FUNCTION "%=="(left_ anyelement, right_ anyelement) RETURNS boolean
79
    LANGUAGE sql STABLE
80
    AS $_$
81
SELECT keys($1) = keys($2)
82
$_$;
83

    
84

    
85
--
86
-- 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
-- Name: _alt(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
96
--
97

    
98
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
    LANGUAGE sql IMMUTABLE
100
    AS $_$
101
SELECT coalesce($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
102
$_$;
103

    
104

    
105
--
106
-- Name: _and(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
107
--
108

    
109
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
    LANGUAGE sql IMMUTABLE
111
    AS $_$
112
SELECT bool_and(value)
113
FROM
114
(VALUES
115
      ($1)
116
    , ($2)
117
    , ($3)
118
    , ($4)
119
    , ($5)
120
)
121
AS v (value)
122
$_$;
123

    
124

    
125
--
126
-- Name: FUNCTION _and("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
127
--
128

    
129
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

    
133

    
134
--
135
-- Name: _avg(double precision, double precision, double precision, double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
136
--
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
-- Name: _dms_to_dd(text); Type: FUNCTION; Schema: util; Owner: -
156
--
157

    
158
CREATE FUNCTION _dms_to_dd(value text DEFAULT NULL::text) RETURNS double precision
159
    LANGUAGE sql IMMUTABLE
160
    AS $_$
161
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
FROM 
163
(
164
    SELECT regexp_matches($1, '^ *(-?)(\d{1,3}(?:\.\d*)?)(?:(?:deg|[°º])(?: *([\d.]+)(?:min|[''’]))?(?: *([\d.]+)(?:sec|["”]))?)? *([NESW])? *$')
165
    UNION ALL
166
    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
)
169
matches (g)
170
$_$;
171

    
172

    
173
--
174
-- Name: _dms_to_dd(double precision, double precision, double precision, compass_dir); Type: FUNCTION; Schema: util; Owner: -
175
--
176

    
177
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
    LANGUAGE sql IMMUTABLE
179
    AS $_$
180
SELECT sum(value)*COALESCE(util._map('N=>1,E=>1,S=>-1,W=>-1', $4::text)::integer, 1)
181
FROM
182
(VALUES
183
      ($1)
184
    , ($2/60)
185
    , ($3/60/60)
186
)
187
AS v (value)
188
$_$;
189

    
190

    
191
--
192
-- Name: _dms_to_dd(text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
193
--
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
SELECT util._dms_to_dd($1::double precision, $2::double precision, $3::double precision, $4::util.compass_dir)
199
$_$;
200

    
201

    
202
--
203
-- Name: _eq(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
204
--
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
-- Name: _fix_date(date, date); Type: FUNCTION; Schema: util; Owner: -
215
--
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
-- Name: _if(boolean, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
228
--
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
-- Name: _if(text, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
239
--
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
SELECT util._if($1 != '', $2, $3)
245
$_$;
246

    
247

    
248
--
249
-- Name: _join(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
250
--
251

    
252
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
    LANGUAGE sql IMMUTABLE
254
    AS $_$
255
SELECT NULLIF(concat_ws('; ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
256
$_$;
257

    
258

    
259
--
260
-- Name: _join_words(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
261
--
262

    
263
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
    LANGUAGE sql IMMUTABLE
265
    AS $_$
266
SELECT NULLIF(concat_ws(' ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
267
$_$;
268

    
269

    
270
--
271
-- Name: _km_to_m(double precision); Type: FUNCTION; Schema: util; Owner: -
272
--
273

    
274
CREATE FUNCTION _km_to_m(value double precision) RETURNS double precision
275
    LANGUAGE sql IMMUTABLE
276
    AS $_$
277
SELECT $1*1000.
278
$_$;
279

    
280

    
281
--
282
-- Name: _label(text, text); Type: FUNCTION; Schema: util; Owner: -
283
--
284

    
285
CREATE FUNCTION _label(label text, value text) RETURNS text
286
    LANGUAGE sql IMMUTABLE
287
    AS $_$
288
SELECT coalesce($1 || ': ', '') || $2
289
$_$;
290

    
291

    
292
--
293
-- Name: _lowercase(text); Type: FUNCTION; Schema: util; Owner: -
294
--
295

    
296
CREATE FUNCTION _lowercase(value text) RETURNS text
297
    LANGUAGE sql IMMUTABLE
298
    AS $_$
299
SELECT lower($1)
300
$_$;
301

    
302

    
303
--
304
-- Name: _map(hstore, anyelement); Type: FUNCTION; Schema: util; Owner: -
305
--
306

    
307
CREATE FUNCTION _map(map hstore, value anyelement) RETURNS anyelement
308
    LANGUAGE plpgsql IMMUTABLE STRICT
309
    AS $$
310
DECLARE
311
    result value%TYPE := util._map(map, value::text)::unknown;
312
BEGIN
313
    RETURN result;
314
END;
315
$$;
316

    
317

    
318
--
319
-- Name: _map(hstore, text); Type: FUNCTION; Schema: util; Owner: -
320
--
321

    
322
CREATE FUNCTION _map(map hstore, value text) RETURNS text
323
    LANGUAGE plpgsql IMMUTABLE STRICT
324
    AS $$
325
DECLARE
326
    match text := map -> value;
327
BEGIN
328
    IF match IS NULL AND NOT map ? value THEN -- no match rather than NULL match
329
        match := map -> '*'; -- use default entry
330
        IF match IS NULL AND NOT map ? '*' THEN match := '!'; -- no default
331
        END IF;
332
    END IF;
333
    
334
    -- Interpret result
335
    IF match = '!' THEN RAISE 'Value not in map: %', value USING ERRCODE = 'data_exception';
336
    ELSIF match = '*' THEN RETURN value;
337
    ELSE RETURN match;
338
    END IF;
339
END;
340
$$;
341

    
342

    
343
--
344
-- Name: _max(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
345
--
346

    
347
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
348
    LANGUAGE sql IMMUTABLE
349
    AS $_$
350
SELECT GREATEST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
351
$_$;
352

    
353

    
354
--
355
-- Name: _merge(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
356
--
357

    
358
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
359
    LANGUAGE sql IMMUTABLE
360
    AS $_$
361
SELECT util.join_strs(value, '; ')
362
FROM
363
(
364
    SELECT *
365
    FROM
366
    (
367
        SELECT
368
        DISTINCT ON (value)
369
        *
370
        FROM
371
        (VALUES
372
              (1, $1)
373
            , (2, $2)
374
            , (3, $3)
375
            , (4, $4)
376
            , (5, $5)
377
            , (6, $6)
378
            , (7, $7)
379
            , (8, $8)
380
            , (9, $9)
381
            , (10, $10)
382
        )
383
        AS v (sort_order, value)
384
        WHERE value IS NOT NULL
385
    )
386
    AS v
387
    ORDER BY sort_order
388
)
389
AS v
390
$_$;
391

    
392

    
393
--
394
-- Name: _merge_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
395
--
396

    
397
CREATE FUNCTION _merge_prefix(prefix text DEFAULT NULL::text, value text DEFAULT NULL::text) RETURNS text
398
    LANGUAGE sql IMMUTABLE
399
    AS $_$
400
SELECT _join_words((CASE WHEN $2 ~ ('^'||$1||E'\\y') THEN NULL ELSE $1 END), $2)
401
$_$;
402

    
403

    
404
--
405
-- Name: _merge_words(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
406
--
407

    
408
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
409
    LANGUAGE sql IMMUTABLE
410
    AS $_$
411
SELECT util.join_strs(value, ' ')
412
FROM
413
(
414
    SELECT *
415
    FROM
416
    (
417
        SELECT
418
        DISTINCT ON (value)
419
        *
420
        FROM
421
        (VALUES
422
              (1, $1)
423
            , (2, $2)
424
            , (3, $3)
425
            , (4, $4)
426
            , (5, $5)
427
            , (6, $6)
428
            , (7, $7)
429
            , (8, $8)
430
            , (9, $9)
431
            , (10, $10)
432
        )
433
        AS v (sort_order, value)
434
        WHERE value IS NOT NULL
435
    )
436
    AS v
437
    ORDER BY sort_order
438
)
439
AS v
440
$_$;
441

    
442

    
443
--
444
-- Name: _min(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
445
--
446

    
447
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
448
    LANGUAGE sql IMMUTABLE
449
    AS $_$
450
SELECT LEAST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
451
$_$;
452

    
453

    
454
--
455
-- Name: _not(boolean); Type: FUNCTION; Schema: util; Owner: -
456
--
457

    
458
CREATE FUNCTION _not(value boolean) RETURNS boolean
459
    LANGUAGE sql IMMUTABLE
460
    AS $_$
461
SELECT NOT $1
462
$_$;
463

    
464

    
465
--
466
-- Name: _now(); Type: FUNCTION; Schema: util; Owner: -
467
--
468

    
469
CREATE FUNCTION _now() RETURNS timestamp with time zone
470
    LANGUAGE sql STABLE
471
    AS $$
472
SELECT now()
473
$$;
474

    
475

    
476
--
477
-- Name: _nullIf(anyelement, text, text); Type: FUNCTION; Schema: util; Owner: -
478
--
479

    
480
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type text) RETURNS anyelement
481
    LANGUAGE sql IMMUTABLE
482
    AS $_$
483
SELECT util."_nullIf"($1, $2, $3::util.datatype)
484
$_$;
485

    
486

    
487
--
488
-- Name: _nullIf(anyelement, text, datatype); Type: FUNCTION; Schema: util; Owner: -
489
--
490

    
491
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type datatype DEFAULT 'str'::datatype) RETURNS anyelement
492
    LANGUAGE plpgsql IMMUTABLE
493
    AS $$
494
DECLARE
495
    type util.datatype NOT NULL := type; -- add NOT NULL
496
BEGIN
497
    IF type = 'str' THEN RETURN nullif(value::text, "null");
498
    -- Invalid value is ignored, but invalid null value generates error
499
    ELSIF type = 'float' THEN
500
        DECLARE
501
            -- Outside the try block so that invalid null value generates error
502
            "null" double precision := "null"::double precision;
503
        BEGIN
504
            RETURN nullif(value::double precision, "null");
505
        EXCEPTION
506
            WHEN data_exception THEN RETURN value; -- ignore invalid value
507
        END;
508
    END IF;
509
END;
510
$$;
511

    
512

    
513
--
514
-- Name: _or(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
515
--
516

    
517
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
518
    LANGUAGE sql IMMUTABLE
519
    AS $_$
520
SELECT bool_or(value)
521
FROM
522
(VALUES
523
      ($1)
524
    , ($2)
525
    , ($3)
526
    , ($4)
527
    , ($5)
528
)
529
AS v (value)
530
$_$;
531

    
532

    
533
--
534
-- Name: FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
535
--
536

    
537
COMMENT ON FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
538
_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.
539
';
540

    
541

    
542
--
543
-- Name: _range(double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
544
--
545

    
546
CREATE FUNCTION _range("from" double precision DEFAULT NULL::double precision, "to" double precision DEFAULT NULL::double precision) RETURNS double precision
547
    LANGUAGE sql IMMUTABLE
548
    AS $_$
549
SELECT $2 - $1
550
$_$;
551

    
552

    
553
--
554
-- Name: _split(text, text); Type: FUNCTION; Schema: util; Owner: -
555
--
556

    
557
CREATE FUNCTION _split(value text DEFAULT NULL::text, separator text DEFAULT '; '::text) RETURNS SETOF text
558
    LANGUAGE sql IMMUTABLE
559
    AS $_$
560
SELECT regexp_split_to_table($1, $2)
561
$_$;
562

    
563

    
564
--
565
-- Name: added_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
566
--
567

    
568
CREATE FUNCTION added_cols(table_ regclass, names regclass) RETURNS SETOF text
569
    LANGUAGE sql STABLE
570
    AS $_$
571
SELECT util.derived_cols($1, $2)
572
UNION
573
SELECT util.eval2set($$
574
SELECT col
575
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
576
JOIN $$||$2||$$ ON "to" = col
577
WHERE "from" LIKE ':%'
578
$$, NULL::text)
579
$_$;
580

    
581

    
582
--
583
-- Name: FUNCTION added_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
584
--
585

    
586
COMMENT ON FUNCTION added_cols(table_ regclass, names regclass) IS '
587
gets table_''s added columns (all the columns not in the original data)
588
';
589

    
590

    
591
--
592
-- Name: all_same_final(anyarray); Type: FUNCTION; Schema: util; Owner: -
593
--
594

    
595
CREATE FUNCTION all_same_final(state anyarray) RETURNS boolean
596
    LANGUAGE sql IMMUTABLE
597
    AS $_$
598
SELECT $1 IS NULL/*no rows*/ OR util.not_empty($1)/*not no_match_sentinel*/
599
$_$;
600

    
601

    
602
--
603
-- Name: all_same_transform(anyarray, anyelement); Type: FUNCTION; Schema: util; Owner: -
604
--
605

    
606
CREATE FUNCTION all_same_transform(state anyarray, value anyelement) RETURNS anyarray
607
    LANGUAGE plpgsql IMMUTABLE
608
    AS $$
609
DECLARE
610
	value_cmp         state%TYPE = ARRAY[value];
611
	state             state%TYPE = COALESCE(state, value_cmp);
612
	no_match_sentinel state%TYPE = value_cmp[1:0]/*=ARRAY[]::state%TYPE*/;
613
BEGIN
614
	RETURN (CASE WHEN value_cmp IS NOT DISTINCT FROM state THEN state ELSE no_match_sentinel END);
615
END;
616
$$;
617

    
618

    
619
--
620
-- Name: analyze_(regclass); Type: FUNCTION; Schema: util; Owner: -
621
--
622

    
623
CREATE FUNCTION analyze_(table_ regclass) RETURNS void
624
    LANGUAGE sql
625
    AS $_$
626
SELECT util.eval($$ANALYZE VERBOSE $$||$1)
627
$_$;
628

    
629

    
630
--
631
-- Name: append_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
632
--
633

    
634
CREATE FUNCTION append_comment(table_ regclass, comment text) RETURNS void
635
    LANGUAGE sql
636
    AS $_$
637
SELECT util.set_comment($1, concat(util.comment($1), $2))
638
$_$;
639

    
640

    
641
--
642
-- Name: FUNCTION append_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
643
--
644

    
645
COMMENT ON FUNCTION append_comment(table_ regclass, comment text) IS '
646
comment: must start and end with a newline
647
';
648

    
649

    
650
--
651
-- Name: array_fill(anyelement, integer); Type: FUNCTION; Schema: util; Owner: -
652
--
653

    
654
CREATE FUNCTION array_fill(value anyelement, length integer) RETURNS anyarray
655
    LANGUAGE sql IMMUTABLE
656
    AS $_$
657
SELECT pg_catalog.array_fill($1, ARRAY[$2])
658
$_$;
659

    
660

    
661
--
662
-- Name: array_length(anyarray); Type: FUNCTION; Schema: util; Owner: -
663
--
664

    
665
CREATE FUNCTION array_length("array" anyarray) RETURNS integer
666
    LANGUAGE sql IMMUTABLE
667
    AS $_$
668
SELECT util.array_length($1, 1)
669
$_$;
670

    
671

    
672
--
673
-- Name: array_length(anyarray, integer); Type: FUNCTION; Schema: util; Owner: -
674
--
675

    
676
CREATE FUNCTION array_length("array" anyarray, dimension integer) RETURNS integer
677
    LANGUAGE sql IMMUTABLE
678
    AS $_$
679
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE COALESCE(pg_catalog.array_length($1, $2), 0) END
680
$_$;
681

    
682

    
683
--
684
-- Name: FUNCTION array_length("array" anyarray, dimension integer); Type: COMMENT; Schema: util; Owner: -
685
--
686

    
687
COMMENT ON FUNCTION array_length("array" anyarray, dimension integer) IS '
688
returns 0 instead of NULL for empty arrays
689
';
690

    
691

    
692
--
693
-- Name: array_reverse(anyarray); Type: FUNCTION; Schema: util; Owner: -
694
--
695

    
696
CREATE FUNCTION array_reverse("array" anyarray) RETURNS anyarray
697
    LANGUAGE sql IMMUTABLE
698
    AS $_$
699
SELECT array(SELECT * FROM util.in_reverse($1))
700
$_$;
701

    
702

    
703
--
704
-- Name: auto_rm_freq(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
705
--
706

    
707
CREATE FUNCTION auto_rm_freq(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS void
708
    LANGUAGE sql
709
    AS $_$
710
SELECT CASE WHEN util.freq_always_1($1, $2)
711
THEN util.rm_freq($1, $2)
712
ELSE util.try_create($$ALTER TABLE $$||util.parent($1[1])||$$ ADD COLUMN $$||quote_ident($2)||$$ bigint NOT NULL$$)
713
END
714
$_$;
715

    
716

    
717
--
718
-- Name: cast(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
719
--
720

    
721
CREATE FUNCTION "cast"(value text, ret_type_null anyelement) RETURNS anyelement
722
    LANGUAGE plpgsql IMMUTABLE
723
    AS $$
724
/* must use LANGUAGE plpgsql because LANGUAGE sql does not assignment-cast the
725
return value, causing a type mismatch */
726
BEGIN
727
	-- will then be assignment-cast to return type via INOUT
728
	RETURN value::cstring;
729
END;
730
$$;
731

    
732

    
733
--
734
-- Name: FUNCTION "cast"(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
735
--
736

    
737
COMMENT ON FUNCTION "cast"(value text, ret_type_null anyelement) IS '
738
allows casting to an arbitrary type without eval()
739

    
740
usage:
741
SELECT util.cast(''value'', NULL::integer);
742

    
743
note that there does *not* need to be a cast from text to the output type,
744
because an INOUT cast is used instead
745
(http://www.postgresql.org/docs/9.3/static/sql-createcast.html#AEN69507)
746

    
747
ret_type_null: NULL::ret_type
748
';
749

    
750

    
751
--
752
-- Name: cluster_index(regclass); Type: FUNCTION; Schema: util; Owner: -
753
--
754

    
755
CREATE FUNCTION cluster_index(table_ regclass) RETURNS regclass
756
    LANGUAGE sql STABLE
757
    AS $_$
758
SELECT indexrelid FROM pg_index WHERE indrelid = $1 AND indisclustered
759
$_$;
760

    
761

    
762
--
763
-- Name: cluster_once(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
764
--
765

    
766
CREATE FUNCTION cluster_once(table_ regclass, index regclass) RETURNS void
767
    LANGUAGE plpgsql STRICT
768
    AS $_$
769
BEGIN
770
    -- not yet clustered (ARRAY[] compares NULLs literally)
771
    IF ARRAY[util.cluster_index(table_)] != ARRAY[index] THEN
772
        EXECUTE $$CLUSTER $$||table_||$$ USING $$||index;
773
    END IF;
774
END;
775
$_$;
776

    
777

    
778
--
779
-- Name: FUNCTION cluster_once(table_ regclass, index regclass); Type: COMMENT; Schema: util; Owner: -
780
--
781

    
782
COMMENT ON FUNCTION cluster_once(table_ regclass, index regclass) IS '
783
idempotent
784
';
785

    
786

    
787
--
788
-- Name: coalesce(anyarray); Type: FUNCTION; Schema: util; Owner: -
789
--
790

    
791
CREATE FUNCTION "coalesce"(VARIADIC values_ anyarray) RETURNS anyelement
792
    LANGUAGE sql IMMUTABLE
793
    AS $_$
794
SELECT value
795
FROM unnest($1) value
796
WHERE value IS NOT NULL
797
LIMIT 1
798
$_$;
799

    
800

    
801
--
802
-- Name: FUNCTION "coalesce"(VARIADIC values_ anyarray); Type: COMMENT; Schema: util; Owner: -
803
--
804

    
805
COMMENT ON FUNCTION "coalesce"(VARIADIC values_ anyarray) IS '
806
uses:
807
* coalescing array elements or rows together
808
* forcing evaluation of all values of a COALESCE()
809
';
810

    
811

    
812
--
813
-- Name: col__min(col_ref); Type: FUNCTION; Schema: util; Owner: -
814
--
815

    
816
CREATE FUNCTION col__min(col col_ref) RETURNS integer
817
    LANGUAGE sql STABLE
818
    AS $_$
819
SELECT util.eval2val($$
820
SELECT $$||quote_ident($1.name)||$$
821
FROM $$||$1.table_||$$
822
ORDER BY $$||quote_ident($1.name)||$$ ASC
823
LIMIT 1
824
$$, NULL::integer)
825
$_$;
826

    
827

    
828
--
829
-- Name: col_comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
830
--
831

    
832
CREATE FUNCTION col_comment(col col_ref) RETURNS text
833
    LANGUAGE plpgsql STABLE STRICT
834
    AS $$
835
DECLARE
836
	comment text;
837
BEGIN
838
	SELECT description
839
	FROM pg_attribute
840
	LEFT JOIN pg_description ON objoid = attrelid
841
		AND classoid = 'pg_class'::regclass AND objsubid = attnum
842
	WHERE attrelid = col.table_ AND attname = col.name
843
	INTO STRICT comment
844
	;
845
	RETURN comment;
846
EXCEPTION
847
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
848
END;
849
$$;
850

    
851

    
852
--
853
-- Name: col_default_sql(col_ref); Type: FUNCTION; Schema: util; Owner: -
854
--
855

    
856
CREATE FUNCTION col_default_sql(col col_ref) RETURNS text
857
    LANGUAGE plpgsql STABLE STRICT
858
    AS $$
859
DECLARE
860
	default_sql text;
861
BEGIN
862
	SELECT adsrc
863
	FROM pg_attribute
864
	LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum
865
	WHERE attrelid = col.table_ AND attname = col.name
866
	INTO STRICT default_sql
867
	;
868
	RETURN default_sql;
869
EXCEPTION
870
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
871
END;
872
$$;
873

    
874

    
875
--
876
-- Name: col_default_value(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
877
--
878

    
879
CREATE FUNCTION col_default_value(col col_ref, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
880
    LANGUAGE sql STABLE
881
    AS $_$
882
SELECT util.eval_expr_passthru(util.col_default_sql($1), $2)
883
$_$;
884

    
885

    
886
--
887
-- Name: FUNCTION col_default_value(col col_ref, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
888
--
889

    
890
COMMENT ON FUNCTION col_default_value(col col_ref, ret_type_null anyelement) IS '
891
ret_type_null: NULL::ret_type
892
';
893

    
894

    
895
--
896
-- Name: col_exists(col_ref); Type: FUNCTION; Schema: util; Owner: -
897
--
898

    
899
CREATE FUNCTION col_exists(col col_ref) RETURNS boolean
900
    LANGUAGE plpgsql STRICT
901
    AS $$
902
BEGIN
903
    PERFORM util.col_type(col);
904
    RETURN true;
905
EXCEPTION
906
    WHEN undefined_column THEN RETURN false;
907
END;
908
$$;
909

    
910

    
911
--
912
-- Name: col_global_names(regtype); Type: FUNCTION; Schema: util; Owner: -
913
--
914

    
915
CREATE FUNCTION col_global_names(type regtype, OUT name text, OUT global_name text) RETURNS SETOF record
916
    LANGUAGE plpgsql STABLE STRICT
917
    AS $$
918
DECLARE
919
    prefix text := util.name(type)||'.';
920
BEGIN
921
    RETURN QUERY
922
        SELECT name_, (CASE WHEN util.contains(search_for:='.', in_str:=name_) THEN '' ELSE prefix END)||name_
923
        FROM util.col_names(type) f (name_);
924
END;
925
$$;
926

    
927

    
928
--
929
-- Name: col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
930
--
931

    
932
CREATE FUNCTION col_names(table_ regclass) RETURNS SETOF text
933
    LANGUAGE sql STABLE
934
    AS $_$
935
SELECT attname::text
936
FROM pg_attribute
937
WHERE attrelid = $1 AND attnum >= 1 AND NOT attisdropped
938
ORDER BY attnum
939
$_$;
940

    
941

    
942
--
943
-- Name: col_names(regtype); Type: FUNCTION; Schema: util; Owner: -
944
--
945

    
946
CREATE FUNCTION col_names(type regtype) RETURNS SETOF text
947
    LANGUAGE plpgsql STABLE STRICT
948
    AS $_$
949
BEGIN
950
    RETURN QUERY EXECUTE $$SELECT skeys(hstore(NULL::$$||type||$$))$$;
951
END;
952
$_$;
953

    
954

    
955
--
956
-- Name: col_type(col_ref); Type: FUNCTION; Schema: util; Owner: -
957
--
958

    
959
CREATE FUNCTION col_type(col col_ref) RETURNS regtype
960
    LANGUAGE plpgsql STABLE STRICT
961
    AS $$
962
DECLARE
963
    type regtype;
964
BEGIN
965
    SELECT atttypid FROM pg_attribute
966
    WHERE attrelid = col.table_ AND attname = col.name
967
    INTO STRICT type
968
    ;
969
    RETURN type;
970
EXCEPTION
971
    WHEN no_data_found THEN
972
        RAISE undefined_column USING MESSAGE =
973
            concat('undefined column: ', col.name);
974
END;
975
$$;
976

    
977

    
978
--
979
-- Name: comment(oid); Type: FUNCTION; Schema: util; Owner: -
980
--
981

    
982
CREATE FUNCTION comment(element oid) RETURNS text
983
    LANGUAGE sql STABLE
984
    AS $_$
985
SELECT description FROM pg_description WHERE objoid = $1
986
$_$;
987

    
988

    
989
--
990
-- Name: concat_esc(text, text); Type: FUNCTION; Schema: util; Owner: -
991
--
992

    
993
CREATE FUNCTION concat_esc("left" text, "right" text) RETURNS text
994
    LANGUAGE sql IMMUTABLE
995
    AS $_$
996
SELECT util.esc_name__append($2, $1)
997
$_$;
998

    
999

    
1000
--
1001
-- Name: contains(text, text); Type: FUNCTION; Schema: util; Owner: -
1002
--
1003

    
1004
CREATE FUNCTION contains(search_for text, in_str text) RETURNS boolean
1005
    LANGUAGE sql IMMUTABLE
1006
    AS $_$
1007
SELECT position($1 in $2) > 0 /*1-based offset*/
1008
$_$;
1009

    
1010

    
1011
--
1012
-- Name: copy_struct(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1013
--
1014

    
1015
CREATE FUNCTION copy_struct(from_ regclass, to_ text) RETURNS void
1016
    LANGUAGE sql
1017
    AS $_$
1018
SELECT util.eval($$CREATE TABLE $$||$2||$$ (LIKE $$||$1||$$ INCLUDING ALL)$$)
1019
$_$;
1020

    
1021

    
1022
--
1023
-- Name: copy_types_and_data(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1024
--
1025

    
1026
CREATE FUNCTION copy_types_and_data(from_ regclass, to_ text) RETURNS void
1027
    LANGUAGE sql
1028
    AS $_$
1029
SELECT util.materialize_view($2, $1)
1030
$_$;
1031

    
1032

    
1033
--
1034
-- Name: create_if_not_exists(text); Type: FUNCTION; Schema: util; Owner: -
1035
--
1036

    
1037
CREATE FUNCTION create_if_not_exists(sql text) RETURNS void
1038
    LANGUAGE plpgsql STRICT
1039
    AS $$
1040
BEGIN
1041
	PERFORM util.eval(sql);
1042
EXCEPTION
1043
WHEN   duplicate_table
1044
	OR duplicate_object -- eg. constraint
1045
	OR duplicate_column
1046
	OR duplicate_function
1047
THEN NULL;
1048
WHEN invalid_table_definition THEN
1049
	IF SQLERRM LIKE 'multiple primary keys for table % are not allowed' THEN NULL;
1050
	ELSE RAISE;
1051
	END IF;
1052
END;
1053
$$;
1054

    
1055

    
1056
--
1057
-- Name: FUNCTION create_if_not_exists(sql text); Type: COMMENT; Schema: util; Owner: -
1058
--
1059

    
1060
COMMENT ON FUNCTION create_if_not_exists(sql text) IS '
1061
idempotent
1062
';
1063

    
1064

    
1065
--
1066
-- Name: curr_func(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1067
--
1068

    
1069
CREATE FUNCTION curr_func(func text, schema_anchor anyelement) RETURNS text
1070
    LANGUAGE sql STABLE
1071
    AS $$
1072
SELECT util.schema_esc(schema_anchor)||'.'||quote_ident(func)
1073
$$;
1074

    
1075

    
1076
--
1077
-- Name: debug_print_func_call(text); Type: FUNCTION; Schema: util; Owner: -
1078
--
1079

    
1080
CREATE FUNCTION debug_print_func_call(func_call text) RETURNS void
1081
    LANGUAGE sql IMMUTABLE
1082
    AS $_$
1083
SELECT util.raise('NOTICE', $$SELECT $$||$1)
1084
$_$;
1085

    
1086

    
1087
--
1088
-- Name: debug_print_return_value(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1089
--
1090

    
1091
CREATE FUNCTION debug_print_return_value(value anyelement, encode boolean DEFAULT false) RETURNS anyelement
1092
    LANGUAGE sql IMMUTABLE
1093
    AS $_$
1094
SELECT util.debug_print_value('returns: ', $1, $2);
1095
SELECT $1;
1096
$_$;
1097

    
1098

    
1099
--
1100
-- Name: debug_print_sql(text); Type: FUNCTION; Schema: util; Owner: -
1101
--
1102

    
1103
CREATE FUNCTION debug_print_sql(sql text) RETURNS void
1104
    LANGUAGE sql IMMUTABLE
1105
    AS $_$
1106
/* newline before so the query starts at the beginning of the line.
1107
newline after to visually separate queries from one another. */
1108
SELECT util.raise('NOTICE', $$
1109
$$||util.runnable_sql($1)||$$
1110
$$||COALESCE(util.explain2notice_msg_if_can($1), ''))
1111
$_$;
1112

    
1113

    
1114
--
1115
-- Name: debug_print_value(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1116
--
1117

    
1118
CREATE FUNCTION debug_print_value(label text, value anyelement, encode boolean DEFAULT false) RETURNS void
1119
    LANGUAGE sql IMMUTABLE
1120
    AS $_$
1121
SELECT util.raise('NOTICE', concat($1,
1122
(CASE WHEN $3 THEN util.quote_typed($2) ELSE $2::text END))||$$
1123
$$)
1124
$_$;
1125

    
1126

    
1127
--
1128
-- Name: debug_print_var(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1129
--
1130

    
1131
CREATE FUNCTION debug_print_var(var text, value anyelement, encode boolean DEFAULT false) RETURNS void
1132
    LANGUAGE sql IMMUTABLE
1133
    AS $_$
1134
/* can't use EXECUTE in the caller because "No substitution of PL/pgSQL
1135
variables is done on the computed command string"
1136
(http://www.postgresql.org/docs/9.3/static/plpgsql-statements.html#PLPGSQL-STATEMENTS-EXECUTING-DYN) */
1137
SELECT util.debug_print_value($1||' = ', $2, $3)
1138
$_$;
1139

    
1140

    
1141
--
1142
-- Name: derived_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1143
--
1144

    
1145
CREATE FUNCTION derived_cols(table_ regclass, names regclass) RETURNS SETOF text
1146
    LANGUAGE sql STABLE
1147
    AS $_$
1148
SELECT util.eval2set($$
1149
SELECT col
1150
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
1151
LEFT JOIN $$||$2||$$ ON "to" = col
1152
WHERE "from" IS NULL
1153
$$, NULL::text)
1154
$_$;
1155

    
1156

    
1157
--
1158
-- Name: FUNCTION derived_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
1159
--
1160

    
1161
COMMENT ON FUNCTION derived_cols(table_ regclass, names regclass) IS '
1162
gets table_''s derived columns (all the columns not in the names table)
1163
';
1164

    
1165

    
1166
--
1167
-- Name: diff(regclass, regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
1168
--
1169

    
1170
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1171
    LANGUAGE sql
1172
    AS $_$
1173
-- create a diff when the # of copies of a row differs between the tables
1174
SELECT util.to_freq($1);
1175
SELECT util.to_freq($2);
1176
SELECT util.auto_rm_freq(ARRAY[$1, $2]);
1177

    
1178
SELECT * FROM util.diff($1, $2, $3, has_freq := true)
1179
$_$;
1180

    
1181

    
1182
--
1183
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1184
--
1185

    
1186
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1187
usage:
1188
SELECT * FROM util.diff(''"left_table"''::regclass, ''"right_table"''::regclass, NULL::shared_base_type)
1189

    
1190
col_type_null (*required*): NULL::shared_base_type
1191
';
1192

    
1193

    
1194
--
1195
-- Name: diff(text, text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1196
--
1197

    
1198
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
1199
    LANGUAGE plpgsql
1200
    SET search_path TO pg_temp
1201
    AS $_$
1202
/* must use LANGUAGE plpgsql because LANGUAGE sql does not support runtime
1203
changes of search_path (schema elements are bound at inline time rather than
1204
runtime) */
1205
/* function option search_path is needed to limit the effects of
1206
`SET LOCAL search_path` to the current function */
1207
BEGIN
1208
	PERFORM util.use_schema($3); -- includes util.%== as default/fallback
1209
	
1210
	PERFORM util.mk_keys_func(pg_typeof($3));
1211
	RETURN QUERY
1212
		SELECT * FROM util.eval2col_pair(util.mk_diff_query($1, $2,
1213
$$/* need to explicitly cast each side to the return type because this does not
1214
happen automatically even when an implicit cast is available */
1215
  left_::$$||util.typeof($3)||$$
1216
, right_::$$||util.typeof($3)
1217
/* when using the util.%==(anyelement, anyelement) operator, you must cast to
1218
the *same* base type, *even though* this is optional when using a custom %== */
1219
, util._if($4, $$true/*= CROSS JOIN*/$$,
1220
$$ left_::$$||util.typeof($3)||$$
1221
%== right_::$$||util.typeof($3)||$$
1222
	-- refer to EXPLAIN output for expansion of %==$$
1223
)
1224
,     $$         left_::$$||util.typeof($3)||$$
1225
IS DISTINCT FROM right_::$$||util.typeof($3)
1226
), $3)
1227
	;
1228
END;
1229
$_$;
1230

    
1231

    
1232
--
1233
-- 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: -
1234
--
1235

    
1236
COMMENT ON FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1237
col_type_null (*required*): NULL::col_type
1238
single_row: whether the tables consist of a single row, which should be
1239
	displayed side-by-side
1240

    
1241
to match up rows using a subset of the columns, create a custom keys() function
1242
which returns this subset as a record:
1243
-- note that OUT parameters for the returned fields are *not* needed
1244
CREATE OR REPLACE FUNCTION [schema].keys(value [schema].[base_type])
1245
  RETURNS record AS
1246
$BODY$
1247
SELECT ($1.key_field_0, $1.key_field_1)
1248
$BODY$
1249
  LANGUAGE sql IMMUTABLE
1250
  COST 100;
1251

    
1252

    
1253
to run EXPLAIN on the FULL JOIN query:
1254
# run this function
1255
# look for a NOTICE containing the expanded query that it ran
1256
# run EXPLAIN on this expanded query
1257
';
1258

    
1259

    
1260
--
1261
-- Name: diff(regclass, regclass, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1262
--
1263

    
1264
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1265
    LANGUAGE sql
1266
    AS $_$
1267
SELECT * FROM util.diff($1::text, $2::text, $3,
1268
	single_row := util.has_single_row($1) AND util.has_single_row($2))
1269
$_$;
1270

    
1271

    
1272
--
1273
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1274
--
1275

    
1276
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1277
helper function used by diff(regclass, regclass)
1278

    
1279
usage:
1280
SELECT * FROM util.diff(''"left_freq_table"''::regclass, ''"right_freq_table"''::regclass, NULL::shared_base_type, has_freq := true)
1281

    
1282
col_type_null (*required*): NULL::shared_base_type
1283
';
1284

    
1285

    
1286
--
1287
-- Name: do_optionally_ignore(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1288
--
1289

    
1290
CREATE FUNCTION do_optionally_ignore(sql text, ignore boolean) RETURNS void
1291
    LANGUAGE sql
1292
    AS $_$
1293
SELECT CASE WHEN $2 THEN util.try_create($1) ELSE util.create_if_not_exists($1) END
1294
$_$;
1295

    
1296

    
1297
--
1298
-- Name: FUNCTION do_optionally_ignore(sql text, ignore boolean); Type: COMMENT; Schema: util; Owner: -
1299
--
1300

    
1301
COMMENT ON FUNCTION do_optionally_ignore(sql text, ignore boolean) IS '
1302
idempotent
1303
';
1304

    
1305

    
1306
--
1307
-- Name: drop_column(col_ref, boolean); Type: FUNCTION; Schema: util; Owner: -
1308
--
1309

    
1310
CREATE FUNCTION drop_column(col col_ref, force boolean DEFAULT false) RETURNS void
1311
    LANGUAGE sql
1312
    AS $_$
1313
SELECT util.eval($$ALTER TABLE $$||$1.table_||$$ DROP COLUMN IF EXISTS $$||
1314
quote_ident($1.name)||util._if($2, $$ CASCADE$$, ''::text))
1315
$_$;
1316

    
1317

    
1318
--
1319
-- Name: FUNCTION drop_column(col col_ref, force boolean); Type: COMMENT; Schema: util; Owner: -
1320
--
1321

    
1322
COMMENT ON FUNCTION drop_column(col col_ref, force boolean) IS '
1323
idempotent
1324
';
1325

    
1326

    
1327
--
1328
-- Name: drop_column(regclass[], text, boolean); Type: FUNCTION; Schema: util; Owner: -
1329
--
1330

    
1331
CREATE FUNCTION drop_column(tables regclass[], col text, force boolean DEFAULT false) RETURNS void
1332
    LANGUAGE sql
1333
    AS $_$
1334
SELECT util.drop_column((table_, $2), $3) FROM unnest($1) table_;
1335
SELECT NULL::void; -- don't fold away functions called in previous query
1336
$_$;
1337

    
1338

    
1339
--
1340
-- Name: FUNCTION drop_column(tables regclass[], col text, force boolean); Type: COMMENT; Schema: util; Owner: -
1341
--
1342

    
1343
COMMENT ON FUNCTION drop_column(tables regclass[], col text, force boolean) IS '
1344
idempotent
1345
';
1346

    
1347

    
1348
--
1349
-- Name: drop_relation(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1350
--
1351

    
1352
CREATE FUNCTION drop_relation(relation anyelement, force boolean DEFAULT false) RETURNS void
1353
    LANGUAGE sql
1354
    AS $_$
1355
/* use util.qual_name() instead of ::text so that the schema qualifier is always
1356
included in the debug SQL */
1357
SELECT util.drop_relation(util.relation_type($1), util.qual_name($1), $2)
1358
$_$;
1359

    
1360

    
1361
--
1362
-- Name: drop_relation(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1363
--
1364

    
1365
CREATE FUNCTION drop_relation(type text, relation_esc text, force boolean DEFAULT false) RETURNS void
1366
    LANGUAGE sql
1367
    AS $_$
1368
SELECT util.eval($$DROP $$||$1||$$ IF EXISTS $$||$2
1369
||util._if($3, $$ CASCADE$$, ''::text))
1370
$_$;
1371

    
1372

    
1373
--
1374
-- Name: FUNCTION drop_relation(type text, relation_esc text, force boolean); Type: COMMENT; Schema: util; Owner: -
1375
--
1376

    
1377
COMMENT ON FUNCTION drop_relation(type text, relation_esc text, force boolean) IS '
1378
idempotent
1379
';
1380

    
1381

    
1382
--
1383
-- Name: drop_relations_like(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1384
--
1385

    
1386
CREATE FUNCTION drop_relations_like(name_regexp text, schema_anchor anyelement, force boolean DEFAULT false) RETURNS void
1387
    LANGUAGE sql
1388
    AS $_$
1389
SELECT util.drop_relations_like($1, util.schema_regexp($2), $3)
1390
$_$;
1391

    
1392

    
1393
--
1394
-- Name: drop_relations_like(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1395
--
1396

    
1397
CREATE FUNCTION drop_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, force boolean DEFAULT false) RETURNS void
1398
    LANGUAGE sql
1399
    AS $_$
1400
SELECT util.debug_print_func_call(util.quote_func_call(
1401
'util.drop_relations_like', util.quote_typed($1), util.quote_typed($2),
1402
util.quote_typed($3)))
1403
;
1404
SELECT util.drop_relation(relation, $3)
1405
FROM util.show_relations_like($1, $2) relation
1406
;
1407
SELECT NULL::void; -- don't fold away functions called in previous query
1408
$_$;
1409

    
1410

    
1411
--
1412
-- Name: drop_table(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1413
--
1414

    
1415
CREATE FUNCTION drop_table(table_ text, force boolean DEFAULT false) RETURNS void
1416
    LANGUAGE sql
1417
    AS $_$
1418
SELECT util.drop_relation('TABLE', $1, $2)
1419
$_$;
1420

    
1421

    
1422
--
1423
-- Name: FUNCTION drop_table(table_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1424
--
1425

    
1426
COMMENT ON FUNCTION drop_table(table_ text, force boolean) IS '
1427
idempotent
1428
';
1429

    
1430

    
1431
--
1432
-- Name: drop_view(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1433
--
1434

    
1435
CREATE FUNCTION drop_view(view_ text, force boolean DEFAULT false) RETURNS void
1436
    LANGUAGE sql
1437
    AS $_$
1438
SELECT util.drop_relation('VIEW', $1, $2)
1439
$_$;
1440

    
1441

    
1442
--
1443
-- Name: FUNCTION drop_view(view_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1444
--
1445

    
1446
COMMENT ON FUNCTION drop_view(view_ text, force boolean) IS '
1447
idempotent
1448
';
1449

    
1450

    
1451
--
1452
-- Name: empty_array(anyelement); Type: FUNCTION; Schema: util; Owner: -
1453
--
1454

    
1455
CREATE FUNCTION empty_array(elem_type_null anyelement DEFAULT NULL::text) RETURNS anyarray
1456
    LANGUAGE sql IMMUTABLE
1457
    AS $_$
1458
SELECT util.array_fill($1, 0)
1459
$_$;
1460

    
1461

    
1462
--
1463
-- Name: FUNCTION empty_array(elem_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1464
--
1465

    
1466
COMMENT ON FUNCTION empty_array(elem_type_null anyelement) IS '
1467
constructs proper empty 1-dimensional array whose dimensions are not NULL ( ''{}''::text[] does not do this)
1468
';
1469

    
1470

    
1471
--
1472
-- Name: ensure_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1473
--
1474

    
1475
CREATE FUNCTION ensure_prefix(prefix text, str text) RETURNS text
1476
    LANGUAGE sql IMMUTABLE
1477
    AS $_$
1478
SELECT (CASE WHEN util.has_prefix($1, $2) THEN $2 ELSE $1||$2 END)
1479
$_$;
1480

    
1481

    
1482
--
1483
-- Name: esc_name__append(text, text); Type: FUNCTION; Schema: util; Owner: -
1484
--
1485

    
1486
CREATE FUNCTION esc_name__append(suffix text, esc_name text) RETURNS text
1487
    LANGUAGE sql IMMUTABLE
1488
    AS $_$
1489
SELECT regexp_replace($2, '("?)$', $1||'\1')
1490
$_$;
1491

    
1492

    
1493
--
1494
-- Name: eval(text[]); Type: FUNCTION; Schema: util; Owner: -
1495
--
1496

    
1497
CREATE FUNCTION eval(queries text[]) RETURNS void
1498
    LANGUAGE sql
1499
    AS $_$
1500
SELECT util.eval(query) FROM unnest($1) query;
1501
SELECT NULL::void; -- don't fold away functions called in previous query
1502
$_$;
1503

    
1504

    
1505
--
1506
-- Name: eval(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1507
--
1508

    
1509
CREATE FUNCTION eval(sql text, verbose_ boolean DEFAULT true) RETURNS void
1510
    LANGUAGE plpgsql
1511
    AS $$
1512
BEGIN
1513
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1514
	EXECUTE sql;
1515
END;
1516
$$;
1517

    
1518

    
1519
--
1520
-- Name: eval2col_pair(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1521
--
1522

    
1523
CREATE FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1524
    LANGUAGE plpgsql
1525
    AS $$
1526
BEGIN
1527
	PERFORM util.debug_print_sql(sql);
1528
	RETURN QUERY EXECUTE sql;
1529
END;
1530
$$;
1531

    
1532

    
1533
--
1534
-- Name: FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1535
--
1536

    
1537
COMMENT ON FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1538
col_type_null (*required*): NULL::col_type
1539
';
1540

    
1541

    
1542
--
1543
-- Name: eval2records(text); Type: FUNCTION; Schema: util; Owner: -
1544
--
1545

    
1546
CREATE FUNCTION eval2records(sql text) RETURNS SETOF record
1547
    LANGUAGE plpgsql
1548
    AS $$
1549
BEGIN
1550
	PERFORM util.debug_print_sql(sql);
1551
	RETURN QUERY EXECUTE sql;
1552
END;
1553
$$;
1554

    
1555

    
1556
--
1557
-- Name: eval2set(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1558
--
1559

    
1560
CREATE FUNCTION eval2set(sql text, ret_type_null anyelement DEFAULT NULL::text, verbose_ boolean DEFAULT true) RETURNS SETOF anyelement
1561
    LANGUAGE plpgsql
1562
    AS $$
1563
BEGIN
1564
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1565
	RETURN QUERY EXECUTE sql;
1566
END;
1567
$$;
1568

    
1569

    
1570
--
1571
-- Name: eval2val(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1572
--
1573

    
1574
CREATE FUNCTION eval2val(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1575
    LANGUAGE plpgsql STABLE
1576
    AS $$
1577
DECLARE
1578
	ret_val ret_type_null%TYPE;
1579
BEGIN
1580
	PERFORM util.debug_print_sql(sql);
1581
	EXECUTE sql INTO STRICT ret_val;
1582
	RETURN ret_val;
1583
END;
1584
$$;
1585

    
1586

    
1587
--
1588
-- Name: FUNCTION eval2val(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1589
--
1590

    
1591
COMMENT ON FUNCTION eval2val(sql text, ret_type_null anyelement) IS '
1592
ret_type_null: NULL::ret_type
1593
';
1594

    
1595

    
1596
--
1597
-- Name: eval_expr(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1598
--
1599

    
1600
CREATE FUNCTION eval_expr(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1601
    LANGUAGE sql
1602
    AS $_$
1603
SELECT util.eval2val($$SELECT $$||$1, $2)
1604
$_$;
1605

    
1606

    
1607
--
1608
-- Name: FUNCTION eval_expr(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1609
--
1610

    
1611
COMMENT ON FUNCTION eval_expr(sql text, ret_type_null anyelement) IS '
1612
ret_type_null: NULL::ret_type
1613
';
1614

    
1615

    
1616
--
1617
-- Name: eval_expr_passthru(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1618
--
1619

    
1620
CREATE FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1621
    LANGUAGE sql
1622
    AS $_$
1623
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE util.eval_expr($1, $2) END
1624
$_$;
1625

    
1626

    
1627
--
1628
-- Name: FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1629
--
1630

    
1631
COMMENT ON FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement) IS '
1632
sql: can be NULL, which will be passed through
1633
ret_type_null: NULL::ret_type
1634
';
1635

    
1636

    
1637
--
1638
-- Name: existing_cols(regclass, text[]); Type: FUNCTION; Schema: util; Owner: -
1639
--
1640

    
1641
CREATE FUNCTION existing_cols(table_ regclass, VARIADIC col_names text[]) RETURNS SETOF text
1642
    LANGUAGE sql STABLE
1643
    AS $_$
1644
SELECT col_name
1645
FROM unnest($2) s (col_name)
1646
WHERE util.col_exists(($1, col_name))
1647
$_$;
1648

    
1649

    
1650
--
1651
-- Name: explain(text); Type: FUNCTION; Schema: util; Owner: -
1652
--
1653

    
1654
CREATE FUNCTION explain(sql text) RETURNS SETOF text
1655
    LANGUAGE sql
1656
    AS $_$
1657
SELECT util.eval2set($$EXPLAIN $$||$1, verbose_ := false)
1658
$_$;
1659

    
1660

    
1661
--
1662
-- Name: explain2notice(text); Type: FUNCTION; Schema: util; Owner: -
1663
--
1664

    
1665
CREATE FUNCTION explain2notice(sql text) RETURNS void
1666
    LANGUAGE sql
1667
    AS $_$
1668
SELECT util.raise('NOTICE', util.explain2notice_msg($1))
1669
$_$;
1670

    
1671

    
1672
--
1673
-- Name: explain2notice_msg(text); Type: FUNCTION; Schema: util; Owner: -
1674
--
1675

    
1676
CREATE FUNCTION explain2notice_msg(sql text) RETURNS text
1677
    LANGUAGE sql
1678
    AS $_$
1679
-- newline before and after to visually separate it from other debug info
1680
SELECT COALESCE($$
1681
EXPLAIN:
1682
$$||util.fold_explain_msg(util.explain2str($1))||$$
1683
$$, '')
1684
$_$;
1685

    
1686

    
1687
--
1688
-- Name: explain2notice_msg_if_can(text); Type: FUNCTION; Schema: util; Owner: -
1689
--
1690

    
1691
CREATE FUNCTION explain2notice_msg_if_can(sql text) RETURNS text
1692
    LANGUAGE plpgsql
1693
    AS $$
1694
BEGIN
1695
	RETURN util.explain2notice_msg(sql);
1696
EXCEPTION
1697
WHEN syntax_error THEN RETURN NULL; -- non-explainable query
1698
	/* don't use util.is_explainable() because the list provided by Postgres
1699
	(http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691)
1700
	excludes some query types that are in fact EXPLAIN-able */
1701
END;
1702
$$;
1703

    
1704

    
1705
--
1706
-- Name: explain2str(text); Type: FUNCTION; Schema: util; Owner: -
1707
--
1708

    
1709
CREATE FUNCTION explain2str(sql text) RETURNS text
1710
    LANGUAGE sql
1711
    AS $_$
1712
SELECT util.join_strs(explain, $$
1713
$$) FROM util.explain($1)
1714
$_$;
1715

    
1716

    
1717
SET default_tablespace = '';
1718

    
1719
SET default_with_oids = false;
1720

    
1721
--
1722
-- Name: explain; Type: TABLE; Schema: util; Owner: -; Tablespace: 
1723
--
1724

    
1725
CREATE TABLE explain (
1726
    line text NOT NULL
1727
);
1728

    
1729

    
1730
--
1731
-- Name: explain2table(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1732
--
1733

    
1734
CREATE FUNCTION explain2table(sql text, table_ regclass DEFAULT 'explain'::regclass) RETURNS void
1735
    LANGUAGE sql
1736
    AS $_$
1737
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT util.explain(
1738
$$||quote_nullable($1)||$$
1739
)$$)
1740
$_$;
1741

    
1742

    
1743
--
1744
-- Name: FUNCTION explain2table(sql text, table_ regclass); Type: COMMENT; Schema: util; Owner: -
1745
--
1746

    
1747
COMMENT ON FUNCTION explain2table(sql text, table_ regclass) IS '
1748
usage:
1749
PERFORM util.explain2table($$
1750
query
1751
$$);
1752
';
1753

    
1754

    
1755
--
1756
-- Name: first_word(text); Type: FUNCTION; Schema: util; Owner: -
1757
--
1758

    
1759
CREATE FUNCTION first_word(str text) RETURNS text
1760
    LANGUAGE sql IMMUTABLE
1761
    AS $_$
1762
SELECT match[1] FROM regexp_matches(util.ltrim_nl($1), '^(\S*)') match
1763
$_$;
1764

    
1765

    
1766
--
1767
-- Name: fix_array(anyarray); Type: FUNCTION; Schema: util; Owner: -
1768
--
1769

    
1770
CREATE FUNCTION fix_array("array" anyarray) RETURNS anyarray
1771
    LANGUAGE sql IMMUTABLE
1772
    AS $_$
1773
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE (
1774
	CASE WHEN pg_catalog.array_ndims($1) IS NULL THEN util.empty_array($1[1]) ELSE $1 END
1775
) END
1776
$_$;
1777

    
1778

    
1779
--
1780
-- Name: FUNCTION fix_array("array" anyarray); Type: COMMENT; Schema: util; Owner: -
1781
--
1782

    
1783
COMMENT ON FUNCTION fix_array("array" anyarray) IS '
1784
ensures that an array will always have proper non-NULL dimensions
1785
';
1786

    
1787

    
1788
--
1789
-- Name: fold_explain_msg(text); Type: FUNCTION; Schema: util; Owner: -
1790
--
1791

    
1792
CREATE FUNCTION fold_explain_msg(explain text) RETURNS text
1793
    LANGUAGE sql IMMUTABLE
1794
    AS $_$
1795
SELECT (CASE WHEN util.first_word($1) = 'Result' THEN NULL ELSE $1 END)
1796
$_$;
1797

    
1798

    
1799
--
1800
-- Name: force_recreate(text, text[]); Type: FUNCTION; Schema: util; Owner: -
1801
--
1802

    
1803
CREATE FUNCTION force_recreate(cmd text, users text[] DEFAULT NULL::text[]) RETURNS void
1804
    LANGUAGE plpgsql
1805
    AS $_$
1806
DECLARE
1807
	PG_EXCEPTION_DETAIL text;
1808
	recreate_users_cmds text[] = util.save_drop_views(users);
1809
BEGIN
1810
	PERFORM util.eval(cmd);
1811
	PERFORM util.eval(recreate_users_cmds);
1812
EXCEPTION
1813
WHEN dependent_objects_still_exist THEN
1814
	IF users IS NOT NULL THEN RAISE; END IF; -- save_drop_views() didn't fix it
1815
	GET STACKED DIAGNOSTICS PG_EXCEPTION_DETAIL = PG_EXCEPTION_DETAIL;
1816
	users = util.array_reverse(array(SELECT * FROM util.regexp_matches_group(
1817
		PG_EXCEPTION_DETAIL, '(?m)^view (.*) depends on [[:lower:]]+ .*$')));
1818
	PERFORM util.debug_print_var('PG_EXCEPTION_DETAIL', PG_EXCEPTION_DETAIL);
1819
	PERFORM util.debug_print_var('users', users);
1820
	IF util.is_empty(users) THEN RAISE; END IF;
1821
	PERFORM util.force_recreate(cmd, users);
1822
END;
1823
$_$;
1824

    
1825

    
1826
--
1827
-- Name: FUNCTION force_recreate(cmd text, users text[]); Type: COMMENT; Schema: util; Owner: -
1828
--
1829

    
1830
COMMENT ON FUNCTION force_recreate(cmd text, users text[]) IS '
1831
idempotent
1832

    
1833
users: not necessary to provide this because it will be autopopulated
1834
';
1835

    
1836

    
1837
--
1838
-- Name: force_update_view(text, text); Type: FUNCTION; Schema: util; Owner: -
1839
--
1840

    
1841
CREATE FUNCTION force_update_view(view_ text, query text) RETURNS void
1842
    LANGUAGE plpgsql STRICT
1843
    AS $_$
1844
DECLARE
1845
	mk_view text = $$CREATE OR REPLACE VIEW $$||view_||$$ AS
1846
$$||query;
1847
BEGIN
1848
	EXECUTE mk_view;
1849
EXCEPTION
1850
WHEN invalid_table_definition THEN
1851
	IF SQLERRM = 'cannot drop columns from view'
1852
	OR SQLERRM LIKE 'cannot change name of view column "%" to "%"'
1853
	THEN
1854
		EXECUTE $$DROP VIEW $$||view_||$$ CASCADE$$;
1855
		EXECUTE mk_view;
1856
	ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM;
1857
	END IF;
1858
END;
1859
$_$;
1860

    
1861

    
1862
--
1863
-- Name: FUNCTION force_update_view(view_ text, query text); Type: COMMENT; Schema: util; Owner: -
1864
--
1865

    
1866
COMMENT ON FUNCTION force_update_view(view_ text, query text) IS '
1867
idempotent
1868
';
1869

    
1870

    
1871
--
1872
-- Name: freq_always_1(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1873
--
1874

    
1875
CREATE FUNCTION freq_always_1(table_ regclass, freq_col text DEFAULT 'copies'::text) RETURNS boolean
1876
    LANGUAGE sql STABLE
1877
    AS $_$
1878
SELECT util.eval2val(
1879
$$SELECT NOT EXISTS( -- there is no row that is != 1
1880
	SELECT NULL
1881
	FROM $$||$1||$$
1882
	WHERE $$||quote_ident(freq_col)||$$ IS DISTINCT FROM 1
1883
	LIMIT 1
1884
)
1885
$$, NULL::boolean)
1886
$_$;
1887

    
1888

    
1889
--
1890
-- Name: freq_always_1(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
1891
--
1892

    
1893
CREATE FUNCTION freq_always_1(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS boolean
1894
    LANGUAGE sql STABLE
1895
    AS $_$
1896
SELECT bool_and(util.freq_always_1(table_, $2)) FROM unnest($1) table_
1897
$_$;
1898

    
1899

    
1900
--
1901
-- Name: grants_users(); Type: FUNCTION; Schema: util; Owner: -
1902
--
1903

    
1904
CREATE FUNCTION grants_users() RETURNS SETOF text
1905
    LANGUAGE sql IMMUTABLE
1906
    AS $$
1907
VALUES ('bien_read'), ('public_')
1908
$$;
1909

    
1910

    
1911
--
1912
-- Name: has_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1913
--
1914

    
1915
CREATE FUNCTION has_prefix(prefix text, str text) RETURNS boolean
1916
    LANGUAGE sql IMMUTABLE
1917
    AS $_$
1918
SELECT substring($2 for length($1)) = $1
1919
$_$;
1920

    
1921

    
1922
--
1923
-- Name: has_single_row(regclass); Type: FUNCTION; Schema: util; Owner: -
1924
--
1925

    
1926
CREATE FUNCTION has_single_row(table_ regclass) RETURNS boolean
1927
    LANGUAGE sql STABLE
1928
    AS $_$
1929
SELECT util.eval2val($$SELECT COUNT(*) = 1 FROM $$||$1, NULL::boolean)
1930
$_$;
1931

    
1932

    
1933
--
1934
-- Name: hstore(text[], text); Type: FUNCTION; Schema: util; Owner: -
1935
--
1936

    
1937
CREATE FUNCTION hstore(keys text[], value text) RETURNS hstore
1938
    LANGUAGE sql IMMUTABLE
1939
    AS $_$
1940
SELECT hstore(util.fix_array($1), util.array_fill($2, util.array_length($1)))
1941
$_$;
1942

    
1943

    
1944
--
1945
-- Name: FUNCTION hstore(keys text[], value text); Type: COMMENT; Schema: util; Owner: -
1946
--
1947

    
1948
COMMENT ON FUNCTION hstore(keys text[], value text) IS '
1949
avoids repeating the same value for each key
1950
';
1951

    
1952

    
1953
--
1954
-- Name: ifnull(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1955
--
1956

    
1957
CREATE FUNCTION ifnull(value anyelement, null_ anyelement) RETURNS anyelement
1958
    LANGUAGE sql IMMUTABLE
1959
    AS $_$
1960
SELECT COALESCE($1, $2)
1961
$_$;
1962

    
1963

    
1964
--
1965
-- Name: FUNCTION ifnull(value anyelement, null_ anyelement); Type: COMMENT; Schema: util; Owner: -
1966
--
1967

    
1968
COMMENT ON FUNCTION ifnull(value anyelement, null_ anyelement) IS '
1969
equivalent to MySQL''s IFNULL() (Postgres auto-lowercases the name)
1970
';
1971

    
1972

    
1973
--
1974
-- Name: in_reverse(anyarray); Type: FUNCTION; Schema: util; Owner: -
1975
--
1976

    
1977
CREATE FUNCTION in_reverse("array" anyarray) RETURNS SETOF anyelement
1978
    LANGUAGE sql IMMUTABLE
1979
    AS $_$
1980
SELECT * FROM unnest($1) ORDER BY row_number() OVER () DESC
1981
$_$;
1982

    
1983

    
1984
--
1985
-- Name: inherit(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1986
--
1987

    
1988
CREATE FUNCTION inherit(derived regclass, base regclass) RETURNS void
1989
    LANGUAGE sql
1990
    AS $_$
1991
SELECT util.eval($$ALTER TABLE $$||$1||$$ INHERIT $$||$2)
1992
$_$;
1993

    
1994

    
1995
--
1996
-- Name: is_castable(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1997
--
1998

    
1999
CREATE FUNCTION is_castable(value text, ret_type_null anyelement) RETURNS boolean
2000
    LANGUAGE plpgsql IMMUTABLE
2001
    AS $$
2002
BEGIN
2003
	PERFORM util.cast(value, ret_type_null);
2004
	-- must happen *after* cast check, because NULL is not valid for some types
2005
	IF value IS NULL THEN RETURN NULL; END IF; -- pass NULL through
2006
	RETURN true;
2007
EXCEPTION
2008
WHEN data_exception THEN RETURN false;
2009
END;
2010
$$;
2011

    
2012

    
2013
--
2014
-- Name: FUNCTION is_castable(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
2015
--
2016

    
2017
COMMENT ON FUNCTION is_castable(value text, ret_type_null anyelement) IS '
2018
passes NULL through. however, if NULL is not valid for the type, false will be
2019
returned instead.
2020

    
2021
ret_type_null: NULL::ret_type
2022
';
2023

    
2024

    
2025
--
2026
-- Name: is_constant(col_ref); Type: FUNCTION; Schema: util; Owner: -
2027
--
2028

    
2029
CREATE FUNCTION is_constant(col col_ref) RETURNS boolean
2030
    LANGUAGE sql STABLE
2031
    AS $_$
2032
SELECT COALESCE(util.col_comment($1) LIKE '
2033
constant
2034
%', false)
2035
$_$;
2036

    
2037

    
2038
--
2039
-- Name: is_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2040
--
2041

    
2042
CREATE FUNCTION is_empty("array" anyarray) RETURNS boolean
2043
    LANGUAGE sql IMMUTABLE
2044
    AS $_$
2045
SELECT util.array_length($1) = 0
2046
$_$;
2047

    
2048

    
2049
--
2050
-- Name: is_explain(text); Type: FUNCTION; Schema: util; Owner: -
2051
--
2052

    
2053
CREATE FUNCTION is_explain(sql text) RETURNS boolean
2054
    LANGUAGE sql IMMUTABLE
2055
    AS $_$
2056
SELECT upper(util.first_word($1)) = 'EXPLAIN'
2057
$_$;
2058

    
2059

    
2060
--
2061
-- Name: is_explainable(text); Type: FUNCTION; Schema: util; Owner: -
2062
--
2063

    
2064
CREATE FUNCTION is_explainable(sql text) RETURNS boolean
2065
    LANGUAGE sql IMMUTABLE
2066
    AS $_$
2067
SELECT upper(util.first_word($1)) = ANY(
2068
'{SELECT,INSERT,UPDATE,DELETE,VALUES,EXECUTE,DECLARE}'::text[]
2069
/*from http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691*/
2070
)
2071
$_$;
2072

    
2073

    
2074
--
2075
-- Name: is_more_complete_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2076
--
2077

    
2078
CREATE FUNCTION is_more_complete_than("left" anyelement, "right" anyelement) RETURNS boolean
2079
    LANGUAGE sql IMMUTABLE
2080
    AS $_$
2081
SELECT $1 IS NOT DISTINCT FROM $2 OR ($1 IS NOT NULL AND $2 IS NULL)
2082
$_$;
2083

    
2084

    
2085
--
2086
-- Name: is_populated_more_often_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2087
--
2088

    
2089
CREATE FUNCTION is_populated_more_often_than("left" anyelement, "right" anyelement) RETURNS boolean
2090
    LANGUAGE sql IMMUTABLE
2091
    AS $_$
2092
SELECT $1 IS NOT NULL >= $2 IS NOT NULL -- true > false
2093
$_$;
2094

    
2095

    
2096
--
2097
-- Name: is_set_stmt(text); Type: FUNCTION; Schema: util; Owner: -
2098
--
2099

    
2100
CREATE FUNCTION is_set_stmt(sql text) RETURNS boolean
2101
    LANGUAGE sql IMMUTABLE
2102
    AS $_$
2103
SELECT upper(util.first_word($1)) = 'SET'
2104
$_$;
2105

    
2106

    
2107
--
2108
-- Name: is_table(regclass); Type: FUNCTION; Schema: util; Owner: -
2109
--
2110

    
2111
CREATE FUNCTION is_table(relation regclass) RETURNS boolean
2112
    LANGUAGE sql STABLE
2113
    AS $_$
2114
SELECT relkind = 'r' FROM pg_class WHERE oid = $1
2115
$_$;
2116

    
2117

    
2118
--
2119
-- Name: is_view(regclass); Type: FUNCTION; Schema: util; Owner: -
2120
--
2121

    
2122
CREATE FUNCTION is_view(relation regclass) RETURNS boolean
2123
    LANGUAGE sql STABLE
2124
    AS $_$
2125
SELECT relkind = 'v' FROM pg_class WHERE oid = $1
2126
$_$;
2127

    
2128

    
2129
--
2130
-- Name: join_strs_transform(text, text, text); Type: FUNCTION; Schema: util; Owner: -
2131
--
2132

    
2133
CREATE FUNCTION join_strs_transform(state text, value text, delim text) RETURNS text
2134
    LANGUAGE sql IMMUTABLE STRICT
2135
    AS $_$
2136
SELECT $1 || $3 || $2
2137
$_$;
2138

    
2139

    
2140
--
2141
-- Name: FUNCTION join_strs_transform(state text, value text, delim text); Type: COMMENT; Schema: util; Owner: -
2142
--
2143

    
2144
COMMENT ON FUNCTION join_strs_transform(state text, value text, delim text) IS '
2145
must be declared STRICT to use the special handling of STRICT aggregating functions
2146
';
2147

    
2148

    
2149
--
2150
-- Name: keys(anyelement); Type: FUNCTION; Schema: util; Owner: -
2151
--
2152

    
2153
CREATE FUNCTION keys(value anyelement) RETURNS anyelement
2154
    LANGUAGE sql IMMUTABLE
2155
    AS $_$
2156
SELECT $1 -- compare on the entire value
2157
$_$;
2158

    
2159

    
2160
--
2161
-- Name: limit2row_num(integer, integer, integer); Type: FUNCTION; Schema: util; Owner: -
2162
--
2163

    
2164
CREATE FUNCTION limit2row_num(limit_ integer, offset_ integer DEFAULT NULL::integer, min_row_num integer DEFAULT 1) RETURNS integer
2165
    LANGUAGE sql IMMUTABLE
2166
    AS $_$
2167
SELECT COALESCE(util.offset2row_num($2, $3) + $1 - 1, 2147483647)
2168
$_$;
2169

    
2170

    
2171
--
2172
-- Name: loop_ignore_errors(text, text, anyelement); Type: FUNCTION; Schema: util; Owner: -
2173
--
2174

    
2175
CREATE FUNCTION loop_ignore_errors(iter_sql text, loop_body_sql text, loop_type_null anyelement DEFAULT NULL::text) RETURNS void
2176
    LANGUAGE plpgsql
2177
    AS $$
2178
DECLARE
2179
	errors_ct integer = 0;
2180
	loop_var loop_type_null%TYPE;
2181
BEGIN
2182
	FOR loop_var IN SELECT * FROM util.eval2set(iter_sql, loop_type_null)
2183
	LOOP
2184
		BEGIN
2185
			EXECUTE loop_body_sql USING loop_var;
2186
		EXCEPTION
2187
		WHEN OTHERS THEN
2188
			errors_ct = errors_ct+1;
2189
			PERFORM util.raise_error_warning(SQLERRM);
2190
		END;
2191
	END LOOP;
2192
	IF errors_ct > 0 THEN
2193
		-- can't raise exception because this would roll back the transaction
2194
		PERFORM util.raise_error_warning('there were '||errors_ct
2195
			||' errors: see the WARNINGs for details');
2196
	END IF;
2197
END;
2198
$$;
2199

    
2200

    
2201
--
2202
-- Name: ltrim_nl(text); Type: FUNCTION; Schema: util; Owner: -
2203
--
2204

    
2205
CREATE FUNCTION ltrim_nl(str text) RETURNS text
2206
    LANGUAGE sql IMMUTABLE
2207
    AS $_$
2208
SELECT ltrim($1, $$
2209
$$)
2210
$_$;
2211

    
2212

    
2213
--
2214
-- Name: map_filter_insert(); Type: FUNCTION; Schema: util; Owner: -
2215
--
2216

    
2217
CREATE FUNCTION map_filter_insert() RETURNS trigger
2218
    LANGUAGE plpgsql
2219
    AS $$
2220
BEGIN
2221
	IF new."from" LIKE ':%' THEN RETURN NULL; END IF; -- exclude metadata values
2222
	RETURN new;
2223
END;
2224
$$;
2225

    
2226

    
2227
--
2228
-- Name: map_get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2229
--
2230

    
2231
CREATE FUNCTION map_get(map regclass, key text) RETURNS text
2232
    LANGUAGE plpgsql STABLE STRICT
2233
    AS $_$
2234
DECLARE
2235
    value text;
2236
BEGIN
2237
    EXECUTE $$SELECT "to" FROM $$||map||$$ WHERE "from" = $1$$
2238
        INTO value USING key;
2239
    RETURN value;
2240
END;
2241
$_$;
2242

    
2243

    
2244
--
2245
-- Name: map_nulls(text[], anyelement); Type: FUNCTION; Schema: util; Owner: -
2246
--
2247

    
2248
CREATE FUNCTION map_nulls(nulls text[], value anyelement) RETURNS anyelement
2249
    LANGUAGE sql IMMUTABLE
2250
    AS $_$
2251
SELECT util._map(util.nulls_map($1), $2)
2252
$_$;
2253

    
2254

    
2255
--
2256
-- Name: FUNCTION map_nulls(nulls text[], value anyelement); Type: COMMENT; Schema: util; Owner: -
2257
--
2258

    
2259
COMMENT ON FUNCTION map_nulls(nulls text[], value anyelement) IS '
2260
due to dynamic inlining[1], this is just as fast as util._map() which it wraps[2].
2261

    
2262
[1] inlining of function calls, which is different from constant folding
2263
[2] _map()''s profiling query
2264
SELECT util._map(''"1"=>NULL, "2"=>NULL, "3"=>NULL, *=>*'', v) FROM unnest(array_fill(1, array[100000])) f (v)
2265
and map_nulls()''s profiling query
2266
SELECT util.map_nulls(array[1, 2, 3]::text[], v) FROM unnest(array_fill(1, array[100000])) f (v)
2267
both take ~920 ms.
2268
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.
2269
';
2270

    
2271

    
2272
--
2273
-- Name: map_values(regclass); Type: FUNCTION; Schema: util; Owner: -
2274
--
2275

    
2276
CREATE FUNCTION map_values(map regclass) RETURNS SETOF text
2277
    LANGUAGE plpgsql STABLE STRICT
2278
    AS $_$
2279
BEGIN
2280
    RETURN QUERY EXECUTE $$SELECT "to" FROM $$||map;
2281
END;
2282
$_$;
2283

    
2284

    
2285
--
2286
-- Name: materialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2287
--
2288

    
2289
CREATE FUNCTION materialize_query(table_esc text, sql text) RETURNS void
2290
    LANGUAGE sql
2291
    AS $_$
2292
SELECT util.create_if_not_exists($$CREATE TABLE $$||$1||$$ AS
2293
$$||util.ltrim_nl($2));
2294
-- make sure the created table has the correct estimated row count
2295
SELECT util.analyze_($1);
2296

    
2297
SELECT util.append_comment($1, '
2298
contents generated from:
2299
'||util.ltrim_nl(util.runnable_sql($2))||';
2300
');
2301
$_$;
2302

    
2303

    
2304
--
2305
-- Name: FUNCTION materialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2306
--
2307

    
2308
COMMENT ON FUNCTION materialize_query(table_esc text, sql text) IS '
2309
idempotent
2310
';
2311

    
2312

    
2313
--
2314
-- Name: materialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2315
--
2316

    
2317
CREATE FUNCTION materialize_view(table_esc text, view_ regclass) RETURNS void
2318
    LANGUAGE sql
2319
    AS $_$
2320
SELECT util.materialize_query($1, $$SELECT * FROM $$||$2)
2321
$_$;
2322

    
2323

    
2324
--
2325
-- Name: FUNCTION materialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2326
--
2327

    
2328
COMMENT ON FUNCTION materialize_view(table_esc text, view_ regclass) IS '
2329
idempotent
2330
';
2331

    
2332

    
2333
--
2334
-- Name: mk_const_col(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
2335
--
2336

    
2337
CREATE FUNCTION mk_const_col(col col_ref, value anyelement) RETURNS void
2338
    LANGUAGE sql
2339
    AS $_$
2340
SELECT util.create_if_not_exists($$
2341
ALTER TABLE $$||$1.table_||$$ ADD COLUMN $$
2342
||quote_ident($1.name)||$$ $$||pg_typeof($2)||util.type_qual($2)||$$ DEFAULT $$
2343
||quote_literal($2)||$$;
2344
COMMENT ON COLUMN $$||$1.table_||$$.$$||quote_ident($1.name)||$$ IS '
2345
constant
2346
';
2347
$$)
2348
$_$;
2349

    
2350

    
2351
--
2352
-- Name: FUNCTION mk_const_col(col col_ref, value anyelement); Type: COMMENT; Schema: util; Owner: -
2353
--
2354

    
2355
COMMENT ON FUNCTION mk_const_col(col col_ref, value anyelement) IS '
2356
idempotent
2357
';
2358

    
2359

    
2360
--
2361
-- Name: mk_derived_col(col_ref, text, boolean); Type: FUNCTION; Schema: util; Owner: -
2362
--
2363

    
2364
CREATE FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean DEFAULT false) RETURNS void
2365
    LANGUAGE plpgsql STRICT
2366
    AS $_$
2367
DECLARE
2368
    type regtype = util.typeof(expr, col.table_::text::regtype);
2369
    col_name_sql text = quote_ident(col.name);
2370
BEGIN
2371
    PERFORM util.create_if_not_exists((CASE WHEN overwrite THEN '' ELSE $$
2372
ALTER TABLE $$||col.table_||$$ ADD   COLUMN $$||col_name_sql||$$      $$||type||$$;$$ END)||$$
2373
ALTER TABLE $$||col.table_||$$ ALTER COLUMN $$||col_name_sql||$$ TYPE $$||type||$$ USING
2374
$$||expr||$$;
2375
$$);
2376
END;
2377
$_$;
2378

    
2379

    
2380
--
2381
-- Name: FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean); Type: COMMENT; Schema: util; Owner: -
2382
--
2383

    
2384
COMMENT ON FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean) IS '
2385
idempotent
2386
';
2387

    
2388

    
2389
--
2390
-- Name: mk_diff_query(text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
2391
--
2392

    
2393
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
2394
    LANGUAGE sql IMMUTABLE
2395
    AS $_$
2396
SELECT
2397
$$SELECT
2398
$$||$3||$$
2399
FROM      $$||$1||$$ left_
2400
FULL JOIN $$||$2||$$ right_
2401
ON $$||$4||$$
2402
WHERE $$||$5||$$
2403
ORDER BY left_, right_
2404
$$
2405
$_$;
2406

    
2407

    
2408
--
2409
-- Name: mk_keys_func(regtype); Type: FUNCTION; Schema: util; Owner: -
2410
--
2411

    
2412
CREATE FUNCTION mk_keys_func(type regtype) RETURNS void
2413
    LANGUAGE sql
2414
    AS $_$
2415
-- keys()
2416
SELECT util.mk_keys_func($1, ARRAY(
2417
SELECT col FROM util.typed_cols($1) col
2418
WHERE (col).type != ANY('{bigint}'::regtype[]) -- not a count col
2419
));
2420

    
2421
-- values_()
2422
SELECT util.mk_keys_func($1, COALESCE(
2423
	NULLIF(ARRAY(
2424
	SELECT col FROM util.typed_cols($1) col
2425
	WHERE (col).type = ANY('{bigint}'::regtype[]) -- is a count col
2426
	), ARRAY[]::util.col_cast[])
2427
, ARRAY(SELECT util.typed_cols($1))) -- no count cols, so use all cols
2428
, 'values_');
2429
$_$;
2430

    
2431

    
2432
--
2433
-- Name: mk_keys_func(regtype, col_cast[], text); Type: FUNCTION; Schema: util; Owner: -
2434
--
2435

    
2436
CREATE FUNCTION mk_keys_func(type regtype, cols col_cast[], name text DEFAULT 'keys'::text) RETURNS void
2437
    LANGUAGE sql
2438
    AS $_$
2439
SELECT util.create_if_not_exists($$
2440
CREATE TYPE $$||util.prefixed_name($3||'_', $1)||$$ AS
2441
($$||util.mk_typed_cols_list($2)||$$);
2442
COMMENT ON TYPE $$||util.prefixed_name($3||'_', $1)||$$ IS '
2443
autogenerated
2444
';
2445
$$);
2446

    
2447
SELECT util.mk_keys_func($1, util.prefixed_name($3||'_', $1)::regtype, $3);
2448
$_$;
2449

    
2450

    
2451
--
2452
-- Name: mk_keys_func(regtype, regtype, text); Type: FUNCTION; Schema: util; Owner: -
2453
--
2454

    
2455
CREATE FUNCTION mk_keys_func(type regtype, return_type regtype, name text DEFAULT 'keys'::text) RETURNS void
2456
    LANGUAGE sql
2457
    AS $_$
2458
SELECT util.create_if_not_exists($$
2459
CREATE FUNCTION $$||util.qual_name(util.schema($1), $3)||$$(value $$
2460
||util.qual_name($1)||$$)
2461
  RETURNS $$||util.qual_name($2)||$$ AS
2462
$BODY1$
2463
SELECT ROW($$||
2464
(SELECT COALESCE(string_agg($$$1.$$||quote_ident((col).col_name), ', '), '')
2465
FROM util.typed_cols($2) col) ||$$)::$$||util.qual_name($2)||$$
2466
$BODY1$
2467
  LANGUAGE sql IMMUTABLE
2468
  COST 100;
2469
$$);
2470
$_$;
2471

    
2472

    
2473
--
2474
-- Name: mk_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2475
--
2476

    
2477
CREATE FUNCTION mk_map_table(table_ text) RETURNS void
2478
    LANGUAGE sql
2479
    AS $_$
2480
SELECT util.create_if_not_exists($$
2481
CREATE TABLE $$||$1||$$
2482
(
2483
    LIKE util.map INCLUDING ALL
2484
);
2485

    
2486
CREATE TRIGGER map_filter_insert
2487
  BEFORE INSERT
2488
  ON $$||$1||$$
2489
  FOR EACH ROW
2490
  EXECUTE PROCEDURE util.map_filter_insert();
2491
$$)
2492
$_$;
2493

    
2494

    
2495
--
2496
-- Name: mk_not_null(text); Type: FUNCTION; Schema: util; Owner: -
2497
--
2498

    
2499
CREATE FUNCTION mk_not_null(text) RETURNS text
2500
    LANGUAGE sql IMMUTABLE
2501
    AS $_$
2502
SELECT COALESCE($1, '<NULL>')
2503
$_$;
2504

    
2505

    
2506
--
2507
-- Name: mk_out_params(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2508
--
2509

    
2510
CREATE FUNCTION mk_out_params(cols col_cast[]) RETURNS text
2511
    LANGUAGE sql IMMUTABLE
2512
    AS $_$
2513
SELECT COALESCE(string_agg($$, OUT $$||(unnest).col_name||$$ $$||
2514
util.qual_name((unnest).type), ''), '')
2515
FROM unnest($1)
2516
$_$;
2517

    
2518

    
2519
--
2520
-- Name: mk_search_path(text[]); Type: FUNCTION; Schema: util; Owner: -
2521
--
2522

    
2523
CREATE FUNCTION mk_search_path(VARIADIC schemas text[]) RETURNS text
2524
    LANGUAGE sql IMMUTABLE
2525
    AS $_$
2526
SELECT string_agg(quote_ident(unnest), ', ') FROM unnest($1||'util'::text)
2527
$_$;
2528

    
2529

    
2530
--
2531
-- Name: FUNCTION mk_search_path(VARIADIC schemas text[]); Type: COMMENT; Schema: util; Owner: -
2532
--
2533

    
2534
COMMENT ON FUNCTION mk_search_path(VARIADIC schemas text[]) IS '
2535
auto-appends util to the search_path to enable use of util operators
2536
';
2537

    
2538

    
2539
--
2540
-- Name: mk_set_search_path(boolean); Type: FUNCTION; Schema: util; Owner: -
2541
--
2542

    
2543
CREATE FUNCTION mk_set_search_path(for_printing boolean DEFAULT false) RETURNS text
2544
    LANGUAGE sql IMMUTABLE
2545
    AS $_$
2546
SELECT util.mk_set_search_path(current_setting('search_path'), $1)
2547
$_$;
2548

    
2549

    
2550
--
2551
-- Name: mk_set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
2552
--
2553

    
2554
CREATE FUNCTION mk_set_search_path(search_path text, for_printing boolean DEFAULT false) RETURNS text
2555
    LANGUAGE sql IMMUTABLE
2556
    AS $_$
2557
/* debug_print_return_value() needed because this function is used with EXECUTE
2558
rather than util.eval() (in order to affect the calling function), so the
2559
search_path would not otherwise be printed */
2560
SELECT $$SET$$||util._if($2, $$ /*LOCAL*/$$::text, $$ LOCAL$$)
2561
||$$ search_path TO $$||$1
2562
$_$;
2563

    
2564

    
2565
--
2566
-- Name: mk_source_col(regclass); Type: FUNCTION; Schema: util; Owner: -
2567
--
2568

    
2569
CREATE FUNCTION mk_source_col(table_ regclass) RETURNS void
2570
    LANGUAGE sql
2571
    AS $_$
2572
SELECT util.mk_const_col(($1, 'source'), util.schema($1))
2573
$_$;
2574

    
2575

    
2576
--
2577
-- Name: FUNCTION mk_source_col(table_ regclass); Type: COMMENT; Schema: util; Owner: -
2578
--
2579

    
2580
COMMENT ON FUNCTION mk_source_col(table_ regclass) IS '
2581
idempotent
2582
';
2583

    
2584

    
2585
--
2586
-- Name: mk_subset_by_row_num_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2587
--
2588

    
2589
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass) RETURNS void
2590
    LANGUAGE plpgsql STRICT
2591
    AS $_$
2592
DECLARE
2593
	view_qual_name text = util.qual_name(view_);
2594
BEGIN
2595
	EXECUTE $$
2596
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2597
  RETURNS SETOF $$||view_||$$ AS
2598
$BODY1$
2599
SELECT * FROM $$||view_qual_name||$$
2600
ORDER BY sort_col
2601
LIMIT $1 OFFSET $2
2602
$BODY1$
2603
  LANGUAGE sql STABLE
2604
  COST 100
2605
  ROWS 1000
2606
$$;
2607
	
2608
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2609
END;
2610
$_$;
2611

    
2612

    
2613
--
2614
-- Name: mk_subset_by_row_num_func(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2615
--
2616

    
2617
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass, row_num_col text) RETURNS void
2618
    LANGUAGE plpgsql STRICT
2619
    AS $_$
2620
DECLARE
2621
	view_qual_name text = util.qual_name(view_);
2622
	row_num__min__fn text = util.esc_name__append('__row_num__min', view_qual_name);
2623
BEGIN
2624
	EXECUTE $$
2625
CREATE OR REPLACE FUNCTION $$||row_num__min__fn||$$()
2626
  RETURNS integer AS
2627
$BODY1$
2628
SELECT $$||quote_ident(row_num_col)||$$
2629
FROM $$||view_qual_name||$$
2630
ORDER BY $$||quote_ident(row_num_col)||$$ ASC
2631
LIMIT 1
2632
$BODY1$
2633
  LANGUAGE sql STABLE
2634
  COST 100;
2635
$$;
2636
	
2637
	EXECUTE $$
2638
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2639
  RETURNS SETOF $$||view_||$$ AS
2640
$BODY1$
2641
SELECT * FROM $$||view_qual_name||$$
2642
WHERE $$||quote_ident(row_num_col)||$$ BETWEEN
2643
	util.offset2row_num(    $2, $$||row_num__min__fn||$$())
2644
AND util.limit2row_num ($1, $2, $$||row_num__min__fn||$$())
2645
ORDER BY $$||quote_ident(row_num_col)||$$
2646
$BODY1$
2647
  LANGUAGE sql STABLE
2648
  COST 100
2649
  ROWS 1000
2650
$$;
2651
	
2652
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2653
END;
2654
$_$;
2655

    
2656

    
2657
--
2658
-- Name: mk_subset_by_row_num_no_sort_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2659
--
2660

    
2661
CREATE FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) RETURNS void
2662
    LANGUAGE plpgsql STRICT
2663
    AS $_$
2664
DECLARE
2665
	view_qual_name text = util.qual_name(view_);
2666
BEGIN
2667
	EXECUTE $$
2668
CREATE OR REPLACE FUNCTION $$||view_||$$(no_sort boolean, limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2669
  RETURNS SETOF $$||view_||$$
2670
  SET enable_sort TO 'off'
2671
  AS
2672
$BODY1$
2673
SELECT * FROM $$||view_qual_name||$$($2, $3)
2674
$BODY1$
2675
  LANGUAGE sql STABLE
2676
  COST 100
2677
  ROWS 1000
2678
;
2679
COMMENT ON FUNCTION $$||view_||$$(no_sort boolean, limit_ integer, offset_ integer) IS '
2680
Use this for limit values greater than ~100,000 to avoid unwanted slow sorts.
2681
If you want to run EXPLAIN and get expanded output, use the regular subset
2682
function instead. (When a config param is set on a function, EXPLAIN produces
2683
just a function scan.)
2684
';
2685
$$;
2686
END;
2687
$_$;
2688

    
2689

    
2690
--
2691
-- Name: FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass); Type: COMMENT; Schema: util; Owner: -
2692
--
2693

    
2694
COMMENT ON FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) IS '
2695
creates subset function which turns off enable_sort
2696
';
2697

    
2698

    
2699
--
2700
-- Name: mk_typed_cols_list(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2701
--
2702

    
2703
CREATE FUNCTION mk_typed_cols_list(cols col_cast[]) RETURNS text
2704
    LANGUAGE sql IMMUTABLE
2705
    AS $_$
2706
SELECT COALESCE(string_agg(quote_ident((unnest).col_name)||$$ $$||
2707
util.qual_name((unnest).type), ', '), '')
2708
FROM unnest($1)
2709
$_$;
2710

    
2711

    
2712
--
2713
-- Name: name(regclass); Type: FUNCTION; Schema: util; Owner: -
2714
--
2715

    
2716
CREATE FUNCTION name(table_ regclass) RETURNS text
2717
    LANGUAGE sql STABLE
2718
    AS $_$
2719
SELECT relname::text FROM pg_class WHERE oid = $1
2720
$_$;
2721

    
2722

    
2723
--
2724
-- Name: name(regtype); Type: FUNCTION; Schema: util; Owner: -
2725
--
2726

    
2727
CREATE FUNCTION name(type regtype) RETURNS text
2728
    LANGUAGE sql STABLE
2729
    AS $_$
2730
SELECT typname::text FROM pg_type WHERE oid = $1
2731
$_$;
2732

    
2733

    
2734
--
2735
-- Name: name_was_truncated(text, integer); Type: FUNCTION; Schema: util; Owner: -
2736
--
2737

    
2738
CREATE FUNCTION name_was_truncated(name_ text, max_prefix_len integer DEFAULT 0) RETURNS boolean
2739
    LANGUAGE sql IMMUTABLE
2740
    AS $_$
2741
SELECT octet_length($1) >= util.namedatalen() - $2
2742
$_$;
2743

    
2744

    
2745
--
2746
-- Name: namedatalen(); Type: FUNCTION; Schema: util; Owner: -
2747
--
2748

    
2749
CREATE FUNCTION namedatalen() RETURNS integer
2750
    LANGUAGE sql IMMUTABLE
2751
    AS $$
2752
SELECT octet_length(repeat('_', 1024/*>63*/)::name::text)
2753
$$;
2754

    
2755

    
2756
--
2757
-- Name: not_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2758
--
2759

    
2760
CREATE FUNCTION not_empty(value anyarray) RETURNS boolean
2761
    LANGUAGE sql IMMUTABLE
2762
    AS $_$
2763
SELECT $1 IS NOT NULL AND util.array_length($1) > 0
2764
$_$;
2765

    
2766

    
2767
--
2768
-- Name: not_null(anyelement); Type: FUNCTION; Schema: util; Owner: -
2769
--
2770

    
2771
CREATE FUNCTION not_null(value anyelement) RETURNS boolean
2772
    LANGUAGE sql IMMUTABLE
2773
    AS $_$
2774
SELECT $1 IS NOT NULL
2775
$_$;
2776

    
2777

    
2778
--
2779
-- Name: nulls_map(text[]); Type: FUNCTION; Schema: util; Owner: -
2780
--
2781

    
2782
CREATE FUNCTION nulls_map(nulls text[]) RETURNS hstore
2783
    LANGUAGE sql IMMUTABLE
2784
    AS $_$
2785
SELECT util.hstore($1, NULL) || '*=>*'
2786
$_$;
2787

    
2788

    
2789
--
2790
-- Name: FUNCTION nulls_map(nulls text[]); Type: COMMENT; Schema: util; Owner: -
2791
--
2792

    
2793
COMMENT ON FUNCTION nulls_map(nulls text[]) IS '
2794
for use with _map()
2795
';
2796

    
2797

    
2798
--
2799
-- Name: offset2row_num(integer, integer); Type: FUNCTION; Schema: util; Owner: -
2800
--
2801

    
2802
CREATE FUNCTION offset2row_num(offset_ integer, min_row_num integer DEFAULT 1) RETURNS integer
2803
    LANGUAGE sql IMMUTABLE
2804
    AS $_$
2805
SELECT $2 + COALESCE($1, 0)
2806
$_$;
2807

    
2808

    
2809
--
2810
-- Name: parent(regclass); Type: FUNCTION; Schema: util; Owner: -
2811
--
2812

    
2813
CREATE FUNCTION parent(table_ regclass) RETURNS regclass
2814
    LANGUAGE sql STABLE
2815
    AS $_$
2816
SELECT inhparent FROM pg_inherits WHERE inhrelid = $1
2817
$_$;
2818

    
2819

    
2820
--
2821
-- Name: populate_table(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2822
--
2823

    
2824
CREATE FUNCTION populate_table(table_ regclass, sql text) RETURNS void
2825
    LANGUAGE sql
2826
    AS $_$
2827
SELECT util.eval($$INSERT INTO $$||$1||$$
2828
$$||util.ltrim_nl($2));
2829
-- make sure the created table has the correct estimated row count
2830
SELECT util.analyze_($1);
2831
$_$;
2832

    
2833

    
2834
--
2835
-- Name: prefixed_name(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
2836
--
2837

    
2838
CREATE FUNCTION prefixed_name(prefix text, type anyelement) RETURNS text
2839
    LANGUAGE sql IMMUTABLE
2840
    AS $_$
2841
SELECT util.qual_name(util.schema($2), $1||util.name($2))
2842
$_$;
2843

    
2844

    
2845
--
2846
-- Name: prepend_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2847
--
2848

    
2849
CREATE FUNCTION prepend_comment(table_ regclass, comment text) RETURNS void
2850
    LANGUAGE sql
2851
    AS $_$
2852
SELECT util.set_comment($1, concat($2, util.comment($1)))
2853
$_$;
2854

    
2855

    
2856
--
2857
-- Name: FUNCTION prepend_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
2858
--
2859

    
2860
COMMENT ON FUNCTION prepend_comment(table_ regclass, comment text) IS '
2861
comment: must start and end with a newline
2862
';
2863

    
2864

    
2865
--
2866
-- Name: qual_name(text[]); Type: FUNCTION; Schema: util; Owner: -
2867
--
2868

    
2869
CREATE FUNCTION qual_name(VARIADIC elems text[]) RETURNS text
2870
    LANGUAGE sql IMMUTABLE
2871
    AS $_$
2872
SELECT string_agg(quote_ident(unnest), '.') FROM unnest($1)
2873
$_$;
2874

    
2875

    
2876
--
2877
-- Name: qual_name(regclass); Type: FUNCTION; Schema: util; Owner: -
2878
--
2879

    
2880
CREATE FUNCTION qual_name(table_ regclass) RETURNS text
2881
    LANGUAGE sql STABLE
2882
    SET search_path TO pg_temp
2883
    AS $_$
2884
SELECT $1::text
2885
$_$;
2886

    
2887

    
2888
--
2889
-- Name: qual_name(regtype); Type: FUNCTION; Schema: util; Owner: -
2890
--
2891

    
2892
CREATE FUNCTION qual_name(type regtype) RETURNS text
2893
    LANGUAGE sql STABLE
2894
    SET search_path TO pg_temp
2895
    AS $_$
2896
SELECT $1::text
2897
$_$;
2898

    
2899

    
2900
--
2901
-- Name: FUNCTION qual_name(type regtype); Type: COMMENT; Schema: util; Owner: -
2902
--
2903

    
2904
COMMENT ON FUNCTION qual_name(type regtype) IS '
2905
a type''s schema-qualified name
2906
';
2907

    
2908

    
2909
--
2910
-- Name: qual_name(unknown); Type: FUNCTION; Schema: util; Owner: -
2911
--
2912

    
2913
CREATE FUNCTION qual_name(type unknown) RETURNS text
2914
    LANGUAGE sql STABLE
2915
    AS $_$
2916
SELECT util.qual_name($1::text::regtype)
2917
$_$;
2918

    
2919

    
2920
--
2921
-- Name: quote_func_call(regprocedure, text[]); Type: FUNCTION; Schema: util; Owner: -
2922
--
2923

    
2924
CREATE FUNCTION quote_func_call(func regprocedure, VARIADIC args_esc text[]) RETURNS text
2925
    LANGUAGE sql IMMUTABLE
2926
    AS $_$
2927
SELECT util.quote_func_call($1::regproc::text, VARIADIC $2)
2928
$_$;
2929

    
2930

    
2931
--
2932
-- Name: quote_func_call(text, text[]); Type: FUNCTION; Schema: util; Owner: -
2933
--
2934

    
2935
CREATE FUNCTION quote_func_call(func_esc text, VARIADIC args_esc text[]) RETURNS text
2936
    LANGUAGE sql IMMUTABLE
2937
    AS $_$
2938
SELECT $1||'('||concat_ws(', ', VARIADIC $2)||')'
2939
$_$;
2940

    
2941

    
2942
--
2943
-- Name: quote_typed(anyelement); Type: FUNCTION; Schema: util; Owner: -
2944
--
2945

    
2946
CREATE FUNCTION quote_typed(value anyelement) RETURNS text
2947
    LANGUAGE sql IMMUTABLE
2948
    AS $_$
2949
SELECT quote_nullable($1)||$$::$$||util.qual_name(pg_typeof($1))
2950
$_$;
2951

    
2952

    
2953
--
2954
-- Name: raise(text, text); Type: FUNCTION; Schema: util; Owner: -
2955
--
2956

    
2957
CREATE FUNCTION raise(type text, msg text) RETURNS void
2958
    LANGUAGE sql IMMUTABLE
2959
    AS $_X$
2960
SELECT util.eval($$
2961
CREATE OR REPLACE FUNCTION pg_temp.__raise()
2962
  RETURNS void AS
2963
-- $__BODY1$ in case msg contains $BODY1$ (in SQL)
2964
$__BODY1$
2965
BEGIN
2966
	RAISE $$||$1||$$ USING MESSAGE = $$||quote_nullable($2)||$$;
2967
END;
2968
$__BODY1$
2969
  LANGUAGE plpgsql IMMUTABLE
2970
  COST 100;
2971
$$, verbose_ := false);
2972

    
2973
SELECT util.eval($$SELECT pg_temp.__raise()$$, verbose_ := false);
2974
$_X$;
2975

    
2976

    
2977
--
2978
-- Name: FUNCTION raise(type text, msg text); Type: COMMENT; Schema: util; Owner: -
2979
--
2980

    
2981
COMMENT ON FUNCTION raise(type text, msg text) IS '
2982
type: a log level from
2983
http://www.postgresql.org/docs/9.3/static/plpgsql-errors-and-messages.html
2984
or a condition name from
2985
http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
2986
';
2987

    
2988

    
2989
--
2990
-- Name: raise_error_warning(text); Type: FUNCTION; Schema: util; Owner: -
2991
--
2992

    
2993
CREATE FUNCTION raise_error_warning(msg text) RETURNS void
2994
    LANGUAGE sql IMMUTABLE
2995
    AS $_$
2996
SELECT util.raise('WARNING', 'ERROR:  '||$1)
2997
$_$;
2998

    
2999

    
3000
--
3001
-- Name: raise_undefined_column(col_ref); Type: FUNCTION; Schema: util; Owner: -
3002
--
3003

    
3004
CREATE FUNCTION raise_undefined_column(col col_ref) RETURNS text
3005
    LANGUAGE plpgsql IMMUTABLE STRICT
3006
    AS $$
3007
BEGIN
3008
	RAISE undefined_column USING MESSAGE = concat('undefined column: ', col.name);
3009
END;
3010
$$;
3011

    
3012

    
3013
--
3014
-- Name: regexp_matches_group(text, text, integer); Type: FUNCTION; Schema: util; Owner: -
3015
--
3016

    
3017
CREATE FUNCTION regexp_matches_group(str text, re text, group_ integer DEFAULT 1) RETURNS SETOF text
3018
    LANGUAGE sql IMMUTABLE
3019
    AS $_$
3020
SELECT regexp_matches[$3] FROM regexp_matches($1, $2, 'g')
3021
$_$;
3022

    
3023

    
3024
--
3025
-- Name: regexp_quote(text); Type: FUNCTION; Schema: util; Owner: -
3026
--
3027

    
3028
CREATE FUNCTION regexp_quote(str text) RETURNS text
3029
    LANGUAGE sql IMMUTABLE
3030
    AS $_$
3031
SELECT regexp_replace($1, '\W', /*\char*/'\\\&', 'g')
3032
$_$;
3033

    
3034

    
3035
--
3036
-- Name: regprocedure(text); Type: FUNCTION; Schema: util; Owner: -
3037
--
3038

    
3039
CREATE FUNCTION regprocedure(func text) RETURNS regprocedure
3040
    LANGUAGE sql IMMUTABLE
3041
    AS $_$
3042
SELECT (CASE WHEN right($1, 1) = ')'
3043
THEN $1::regprocedure ELSE $1::regproc::regprocedure END)
3044
$_$;
3045

    
3046

    
3047
--
3048
-- Name: relation_type(regclass); Type: FUNCTION; Schema: util; Owner: -
3049
--
3050

    
3051
CREATE FUNCTION relation_type(relation regclass) RETURNS text
3052
    LANGUAGE sql STABLE
3053
    AS $_$
3054
SELECT util.relation_type(util.relation_type_char($1))
3055
$_$;
3056

    
3057

    
3058
--
3059
-- Name: relation_type("char"); Type: FUNCTION; Schema: util; Owner: -
3060
--
3061

    
3062
CREATE FUNCTION relation_type(relation_type_char "char") RETURNS text
3063
    LANGUAGE sql IMMUTABLE
3064
    AS $_$
3065
SELECT 'c=>TYPE, r=>TABLE, v=>VIEW'::hstore -> $1
3066
$_$;
3067

    
3068

    
3069
--
3070
-- Name: relation_type(regtype); Type: FUNCTION; Schema: util; Owner: -
3071
--
3072

    
3073
CREATE FUNCTION relation_type(type regtype) RETURNS text
3074
    LANGUAGE sql IMMUTABLE
3075
    AS $$
3076
SELECT 'TYPE'::text
3077
$$;
3078

    
3079

    
3080
--
3081
-- Name: relation_type_char(regclass); Type: FUNCTION; Schema: util; Owner: -
3082
--
3083

    
3084
CREATE FUNCTION relation_type_char(relation regclass) RETURNS "char"
3085
    LANGUAGE sql STABLE
3086
    AS $_$
3087
SELECT relkind FROM pg_class WHERE oid = $1
3088
$_$;
3089

    
3090

    
3091
--
3092
-- Name: remake_diff_table(text, regclass, regclass, text); Type: FUNCTION; Schema: util; Owner: -
3093
--
3094

    
3095
CREATE FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) RETURNS void
3096
    LANGUAGE sql
3097
    AS $_$
3098
/* can't have in_table/out_table inherit from *each other*, because inheritance
3099
also causes the rows of the parent table to be included in the child table.
3100
instead, they need to inherit from a common, empty table. */
3101
SELECT util.create_if_not_exists($$SELECT $$||util.quote_func_call(
3102
'util.copy_struct', util.quote_typed($2), util.quote_typed($4)));
3103
SELECT util.rm_freq(ARRAY[$4]); -- left/right_table don't have freq yet
3104
SELECT util.inherit($2, $4);
3105
SELECT util.inherit($3, $4);
3106

    
3107
SELECT util.rematerialize_query($1, $$
3108
SELECT * FROM util.diff(
3109
  $$||util.quote_typed($2)||$$
3110
, $$||util.quote_typed($3)||$$
3111
, NULL::$$||$4||$$)
3112
$$);
3113

    
3114
/* the table unfortunately cannot be *materialized* in human-readable form,
3115
because this would create column name collisions between the two sides */
3116
SELECT util.prepend_comment($1, '
3117
to view this table in human-readable form (with each side''s tuple column
3118
expanded to its component fields):
3119
SELECT (left_).*, ('||util.schema($4::regclass)||'.values_(right_)).* FROM '||$1||';
3120

    
3121
to display NULL values that are extra or missing:
3122
SELECT * FROM '||$1||';
3123
');
3124
$_$;
3125

    
3126

    
3127
--
3128
-- Name: FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text); Type: COMMENT; Schema: util; Owner: -
3129
--
3130

    
3131
COMMENT ON FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) IS '
3132
type_table (*required*): table to create as the shared base type
3133
';
3134

    
3135

    
3136
--
3137
-- Name: rematerialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
3138
--
3139

    
3140
CREATE FUNCTION rematerialize_query(table_esc text, sql text) RETURNS void
3141
    LANGUAGE sql
3142
    AS $_$
3143
SELECT util.drop_table($1);
3144
SELECT util.materialize_query($1, $2);
3145
$_$;
3146

    
3147

    
3148
--
3149
-- Name: FUNCTION rematerialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
3150
--
3151

    
3152
COMMENT ON FUNCTION rematerialize_query(table_esc text, sql text) IS '
3153
idempotent, but repeats action each time
3154
';
3155

    
3156

    
3157
--
3158
-- Name: rematerialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
3159
--
3160

    
3161
CREATE FUNCTION rematerialize_view(table_esc text, view_ regclass) RETURNS void
3162
    LANGUAGE sql
3163
    AS $_$
3164
SELECT util.drop_table($1);
3165
SELECT util.materialize_view($1, $2);
3166
$_$;
3167

    
3168

    
3169
--
3170
-- Name: FUNCTION rematerialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
3171
--
3172

    
3173
COMMENT ON FUNCTION rematerialize_view(table_esc text, view_ regclass) IS '
3174
idempotent, but repeats action each time
3175
';
3176

    
3177

    
3178
--
3179
-- Name: rename_cols(regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
3180
--
3181

    
3182
CREATE FUNCTION rename_cols(table_ regclass, renames anyelement) RETURNS void
3183
    LANGUAGE sql
3184
    AS $_$
3185
SELECT util.try_create($$ALTER TABLE $$||$1||$$ RENAME $$
3186
||quote_ident(name)||$$ TO $$||quote_ident($2 -> name))
3187
FROM util.col_names($1::text::regtype) f (name);
3188
SELECT NULL::void; -- don't fold away functions called in previous query
3189
$_$;
3190

    
3191

    
3192
--
3193
-- Name: FUNCTION rename_cols(table_ regclass, renames anyelement); Type: COMMENT; Schema: util; Owner: -
3194
--
3195

    
3196
COMMENT ON FUNCTION rename_cols(table_ regclass, renames anyelement) IS '
3197
idempotent
3198
';
3199

    
3200

    
3201
--
3202
-- Name: rename_relation(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3203
--
3204

    
3205
CREATE FUNCTION rename_relation(from_ regclass, to_ text) RETURNS void
3206
    LANGUAGE sql
3207
    AS $_$
3208
/* use util.qual_name() instead of ::text so that the schema qualifier is always
3209
included in the debug SQL */
3210
SELECT util.rename_relation(util.qual_name($1), $2)
3211
$_$;
3212

    
3213

    
3214
--
3215
-- Name: rename_relation(text, text); Type: FUNCTION; Schema: util; Owner: -
3216
--
3217

    
3218
CREATE FUNCTION rename_relation(from_esc text, to_name text) RETURNS void
3219
    LANGUAGE sql
3220
    AS $_$
3221
/* 'ALTER TABLE can be used with views too'
3222
(http://www.postgresql.org/docs/9.3/static/sql-alterview.html) */
3223
SELECT util.eval($$ALTER TABLE IF EXISTS $$||$1||$$ RENAME TO $$
3224
||quote_ident($2))
3225
$_$;
3226

    
3227

    
3228
--
3229
-- Name: FUNCTION rename_relation(from_esc text, to_name text); Type: COMMENT; Schema: util; Owner: -
3230
--
3231

    
3232
COMMENT ON FUNCTION rename_relation(from_esc text, to_name text) IS '
3233
idempotent
3234
';
3235

    
3236

    
3237
--
3238
-- Name: replace_suffix(text, text, text, integer); Type: FUNCTION; Schema: util; Owner: -
3239
--
3240

    
3241
CREATE FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer DEFAULT 0) RETURNS text
3242
    LANGUAGE sql IMMUTABLE
3243
    AS $_$
3244
SELECT regexp_replace($1, util.truncated_prefixed_name_regexp($2, $4), '\1'||$3)
3245
$_$;
3246

    
3247

    
3248
--
3249
-- Name: FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer); Type: COMMENT; Schema: util; Owner: -
3250
--
3251

    
3252
COMMENT ON FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer) IS '
3253
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 
3254
';
3255

    
3256

    
3257
--
3258
-- Name: reset_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3259
--
3260

    
3261
CREATE FUNCTION reset_col_names(table_ regclass, names regclass) RETURNS void
3262
    LANGUAGE sql
3263
    AS $_$
3264
SELECT util.eval($$DELETE FROM $$||$2||$$ WHERE "from" LIKE ':%'$$);
3265
SELECT util.mk_derived_col(($2, 'to'), $$"from"$$, overwrite := true);
3266
SELECT util.set_col_names($1, $2);
3267
$_$;
3268

    
3269

    
3270
--
3271
-- Name: FUNCTION reset_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3272
--
3273

    
3274
COMMENT ON FUNCTION reset_col_names(table_ regclass, names regclass) IS '
3275
idempotent.
3276
alters the names table, so it will need to be repopulated after running this function.
3277
';
3278

    
3279

    
3280
--
3281
-- Name: reset_map_table(text); Type: FUNCTION; Schema: util; Owner: -
3282
--
3283

    
3284
CREATE FUNCTION reset_map_table(table_ text) RETURNS void
3285
    LANGUAGE sql
3286
    AS $_$
3287
SELECT util.drop_table($1);
3288
SELECT util.mk_map_table($1);
3289
$_$;
3290

    
3291

    
3292
--
3293
-- Name: rm_freq(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
3294
--
3295

    
3296
CREATE FUNCTION rm_freq(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS void
3297
    LANGUAGE sql
3298
    AS $_$
3299
SELECT util.drop_column($1, $2, force := true)
3300
$_$;
3301

    
3302

    
3303
--
3304
-- Name: rtrim_n(text, integer); Type: FUNCTION; Schema: util; Owner: -
3305
--
3306

    
3307
CREATE FUNCTION rtrim_n(str text, count integer) RETURNS text
3308
    LANGUAGE sql IMMUTABLE
3309
    AS $_$
3310
SELECT (CASE WHEN $2 <= 0 THEN $1 ELSE left($1, -$2) END)
3311
$_$;
3312

    
3313

    
3314
--
3315
-- Name: runnable_sql(text); Type: FUNCTION; Schema: util; Owner: -
3316
--
3317

    
3318
CREATE FUNCTION runnable_sql(sql text) RETURNS text
3319
    LANGUAGE sql IMMUTABLE
3320
    AS $_$
3321
SELECT (CASE WHEN util.is_set_stmt($1) THEN ''
3322
ELSE util.mk_set_search_path(for_printing := true)||$$;
3323
$$ END)||$1
3324
$_$;
3325

    
3326

    
3327
--
3328
-- Name: save_drop_view(text); Type: FUNCTION; Schema: util; Owner: -
3329
--
3330

    
3331
CREATE FUNCTION save_drop_view(view_ text) RETURNS text
3332
    LANGUAGE plpgsql STRICT
3333
    AS $_$
3334
DECLARE
3335
	result text = NULL;
3336
BEGIN
3337
	BEGIN
3338
		result = util.show_create_view(view_);
3339
		PERFORM util.eval($$DROP VIEW $$||view_);
3340
	EXCEPTION
3341
		WHEN undefined_table THEN NULL;
3342
	END;
3343
	RETURN result;
3344
END;
3345
$_$;
3346

    
3347

    
3348
--
3349
-- Name: save_drop_views(text[]); Type: FUNCTION; Schema: util; Owner: -
3350
--
3351

    
3352
CREATE FUNCTION save_drop_views(views text[]) RETURNS text[]
3353
    LANGUAGE sql
3354
    AS $_$
3355
SELECT array(SELECT util.save_drop_view(view_) FROM unnest($1) view_)
3356
$_$;
3357

    
3358

    
3359
--
3360
-- Name: schema(oid); Type: FUNCTION; Schema: util; Owner: -
3361
--
3362

    
3363
CREATE FUNCTION schema(pg_namespace_oid oid) RETURNS text
3364
    LANGUAGE sql STABLE
3365
    AS $_$
3366
SELECT nspname::text FROM pg_namespace WHERE pg_namespace.oid = $1
3367
$_$;
3368

    
3369

    
3370
--
3371
-- Name: schema(regclass); Type: FUNCTION; Schema: util; Owner: -
3372
--
3373

    
3374
CREATE FUNCTION schema(table_ regclass) RETURNS text
3375
    LANGUAGE sql STABLE
3376
    AS $_$
3377
SELECT util.schema(relnamespace) FROM pg_class WHERE oid = $1
3378
$_$;
3379

    
3380

    
3381
--
3382
-- Name: schema(regtype); Type: FUNCTION; Schema: util; Owner: -
3383
--
3384

    
3385
CREATE FUNCTION schema(type regtype) RETURNS text
3386
    LANGUAGE sql STABLE
3387
    AS $_$
3388
SELECT util.schema(typnamespace) FROM pg_type WHERE oid = $1
3389
$_$;
3390

    
3391

    
3392
--
3393
-- Name: schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3394
--
3395

    
3396
CREATE FUNCTION schema(type_null anyelement) RETURNS text
3397
    LANGUAGE sql STABLE
3398
    AS $_$
3399
SELECT util.schema(pg_typeof($1))
3400
$_$;
3401

    
3402

    
3403
--
3404
-- Name: schema_bundle_get_schemas(text); Type: FUNCTION; Schema: util; Owner: -
3405
--
3406

    
3407
CREATE FUNCTION schema_bundle_get_schemas(schema_bundle text) RETURNS SETOF text
3408
    LANGUAGE sql STABLE
3409
    AS $_$
3410
SELECT nspname::text FROM pg_namespace WHERE nspname ~ ('^'||$1||'(?=\y|_)')
3411
$_$;
3412

    
3413

    
3414
--
3415
-- Name: FUNCTION schema_bundle_get_schemas(schema_bundle text); Type: COMMENT; Schema: util; Owner: -
3416
--
3417

    
3418
COMMENT ON FUNCTION schema_bundle_get_schemas(schema_bundle text) IS '
3419
a schema bundle is a group of schemas with a common prefix
3420
';
3421

    
3422

    
3423
--
3424
-- Name: schema_bundle_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3425
--
3426

    
3427
CREATE FUNCTION schema_bundle_rename(old text, new text) RETURNS void
3428
    LANGUAGE sql
3429
    AS $_$
3430
SELECT util.schema_rename(old_schema,
3431
	overlay(old_schema placing new from 1 for length(old))) -- replace prefix
3432
FROM util.schema_bundle_get_schemas($1) f (old_schema);
3433
SELECT NULL::void; -- don't fold away functions called in previous query
3434
$_$;
3435

    
3436

    
3437
--
3438
-- Name: schema_bundle_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3439
--
3440

    
3441
CREATE FUNCTION schema_bundle_replace(replace text, with_ text) RETURNS void
3442
    LANGUAGE plpgsql
3443
    AS $$
3444
BEGIN
3445
	-- don't schema_bundle_rm() the schema_bundle to keep!
3446
	IF replace = with_ THEN RETURN; END IF;
3447
	
3448
	PERFORM util.schema_bundle_rm(replace);
3449
	PERFORM util.schema_bundle_rename(with_, replace);
3450
END;
3451
$$;
3452

    
3453

    
3454
--
3455
-- Name: schema_bundle_rm(text); Type: FUNCTION; Schema: util; Owner: -
3456
--
3457

    
3458
CREATE FUNCTION schema_bundle_rm(schema_bundle text) RETURNS void
3459
    LANGUAGE sql
3460
    AS $_$
3461
SELECT util.schema_rm(schema)
3462
FROM util.schema_bundle_get_schemas($1) f (schema);
3463
SELECT NULL::void; -- don't fold away functions called in previous query
3464
$_$;
3465

    
3466

    
3467
--
3468
-- Name: schema_esc(anyelement); Type: FUNCTION; Schema: util; Owner: -
3469
--
3470

    
3471
CREATE FUNCTION schema_esc(type_null anyelement) RETURNS text
3472
    LANGUAGE sql STABLE
3473
    AS $_$
3474
SELECT quote_ident(util.schema($1))
3475
$_$;
3476

    
3477

    
3478
--
3479
-- Name: schema_matches(text, text); Type: FUNCTION; Schema: util; Owner: -
3480
--
3481

    
3482
CREATE FUNCTION schema_matches(schema text, schema_regexp text) RETURNS boolean
3483
    LANGUAGE sql IMMUTABLE
3484
    AS $_$
3485
SELECT $1 ~ $2 AND /*in userspace*/$1 !~ '^(?:information_schema|pg_.*)$'
3486
$_$;
3487

    
3488

    
3489
--
3490
-- Name: schema_oid(text); Type: FUNCTION; Schema: util; Owner: -
3491
--
3492

    
3493
CREATE FUNCTION schema_oid(schema text) RETURNS oid
3494
    LANGUAGE sql STABLE
3495
    AS $_$
3496
SELECT oid FROM pg_namespace WHERE nspname = $1
3497
$_$;
3498

    
3499

    
3500
--
3501
-- Name: schema_regexp(regclass); Type: FUNCTION; Schema: util; Owner: -
3502
--
3503

    
3504
CREATE FUNCTION schema_regexp(relation regclass) RETURNS text
3505
    LANGUAGE sql IMMUTABLE
3506
    AS $_$
3507
SELECT util.schema_regexp(schema_anchor := $1)
3508
$_$;
3509

    
3510

    
3511
--
3512
-- Name: schema_regexp(anyelement); Type: FUNCTION; Schema: util; Owner: -
3513
--
3514

    
3515
CREATE FUNCTION schema_regexp(schema_anchor anyelement) RETURNS text
3516
    LANGUAGE sql IMMUTABLE
3517
    AS $_$
3518
SELECT util.str_equality_regexp(util.schema($1))
3519
$_$;
3520

    
3521

    
3522
--
3523
-- Name: schema_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3524
--
3525

    
3526
CREATE FUNCTION schema_rename(old text, new text) RETURNS void
3527
    LANGUAGE sql
3528
    AS $_$
3529
SELECT util.eval($$ALTER SCHEMA $$||quote_ident($1)||$$ RENAME TO $$||quote_ident($2));
3530
$_$;
3531

    
3532

    
3533
--
3534
-- Name: schema_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3535
--
3536

    
3537
CREATE FUNCTION schema_replace(replace text, with_ text) RETURNS void
3538
    LANGUAGE plpgsql
3539
    AS $$
3540
BEGIN
3541
	-- don't schema_rm() the schema to keep!
3542
	IF replace = with_ THEN RETURN; END IF;
3543
	
3544
	PERFORM util.schema_rm(replace);
3545
	PERFORM util.schema_rename(with_, replace);
3546
END;
3547
$$;
3548

    
3549

    
3550
--
3551
-- Name: schema_rm(text); Type: FUNCTION; Schema: util; Owner: -
3552
--
3553

    
3554
CREATE FUNCTION schema_rm(schema text) RETURNS void
3555
    LANGUAGE sql
3556
    AS $_$
3557
SELECT util.eval($$DROP SCHEMA IF EXISTS $$||quote_ident($1)||$$ CASCADE$$);
3558
$_$;
3559

    
3560

    
3561
--
3562
-- Name: search_path_append(text); Type: FUNCTION; Schema: util; Owner: -
3563
--
3564

    
3565
CREATE FUNCTION search_path_append(schemas text) RETURNS void
3566
    LANGUAGE sql
3567
    AS $_$
3568
SELECT util.eval(
3569
$$SET search_path TO $$||current_setting('search_path')||$$, $$||$1);
3570
$_$;
3571

    
3572

    
3573
--
3574
-- Name: set_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3575
--
3576

    
3577
CREATE FUNCTION set_col_names(table_ regclass, names regclass) RETURNS void
3578
    LANGUAGE plpgsql STRICT
3579
    AS $_$
3580
DECLARE
3581
    old text[] = ARRAY(SELECT util.col_names(table_));
3582
    new text[] = ARRAY(SELECT util.map_values(names));
3583
BEGIN
3584
    old = old[1:array_length(new, 1)]; -- truncate to same length
3585
    PERFORM util.eval($$ALTER TABLE $$||$1||$$ RENAME $$||quote_ident(key)
3586
||$$ TO $$||quote_ident(value))
3587
    FROM each(hstore(old, new))
3588
    WHERE value != key -- not same name
3589
    ;
3590
END;
3591
$_$;
3592

    
3593

    
3594
--
3595
-- Name: FUNCTION set_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3596
--
3597

    
3598
COMMENT ON FUNCTION set_col_names(table_ regclass, names regclass) IS '
3599
idempotent
3600
';
3601

    
3602

    
3603
--
3604
-- Name: set_col_names_with_metadata(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3605
--
3606

    
3607
CREATE FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) RETURNS void
3608
    LANGUAGE plpgsql STRICT
3609
    AS $_$
3610
DECLARE
3611
	row_ util.map;
3612
BEGIN
3613
	-- rename any metadata cols rather than re-adding them with new names
3614
	BEGIN
3615
		PERFORM util.set_col_names(table_, names);
3616
	EXCEPTION
3617
		WHEN array_subscript_error THEN -- selective suppress
3618
			IF SQLERRM LIKE 'arrays must have same bounds' THEN NULL;
3619
				-- metadata cols not yet added
3620
			ELSE RAISE;
3621
			END IF;
3622
	END;
3623
	
3624
	FOR row_ IN EXECUTE $$SELECT * FROM $$||names||$$ WHERE "from" LIKE ':%'$$
3625
	LOOP
3626
		PERFORM util.mk_const_col((table_, row_."to"),
3627
			substring(row_."from" from 2));
3628
	END LOOP;
3629
	
3630
	PERFORM util.set_col_names(table_, names);
3631
END;
3632
$_$;
3633

    
3634

    
3635
--
3636
-- Name: FUNCTION set_col_names_with_metadata(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3637
--
3638

    
3639
COMMENT ON FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) IS '
3640
idempotent.
3641
the metadata mappings must be *last* in the names table.
3642
';
3643

    
3644

    
3645
--
3646
-- Name: set_col_types(regclass, col_cast[]); Type: FUNCTION; Schema: util; Owner: -
3647
--
3648

    
3649
CREATE FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) RETURNS void
3650
    LANGUAGE sql
3651
    AS $_$
3652
SELECT util.eval(COALESCE(
3653
$$ALTER TABLE $$||$1||$$
3654
$$||(
3655
	SELECT
3656
	string_agg($$ALTER COLUMN $$||col_name_sql||$$ TYPE $$||target_type
3657
	||$$ USING $$||col_name_sql||$$::$$||target_type, $$
3658
, $$)
3659
	FROM
3660
	(
3661
		SELECT
3662
		  quote_ident(col_name) AS col_name_sql
3663
		, util.col_type(($1, col_name)) AS curr_type
3664
		, type AS target_type
3665
		FROM unnest($2)
3666
	) s
3667
	WHERE curr_type != target_type
3668
), ''))
3669
$_$;
3670

    
3671

    
3672
--
3673
-- Name: FUNCTION set_col_types(table_ regclass, col_casts col_cast[]); Type: COMMENT; Schema: util; Owner: -
3674
--
3675

    
3676
COMMENT ON FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) IS '
3677
idempotent
3678
';
3679

    
3680

    
3681
--
3682
-- Name: set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3683
--
3684

    
3685
CREATE FUNCTION set_comment(table_ regclass, comment text) RETURNS void
3686
    LANGUAGE sql
3687
    AS $_$
3688
SELECT util.eval($$COMMENT ON TABLE $$||$1||$$ IS $$||quote_nullable($2))
3689
$_$;
3690

    
3691

    
3692
--
3693
-- Name: set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
3694
--
3695

    
3696
CREATE FUNCTION set_search_path(search_path text, for_session boolean DEFAULT false) RETURNS void
3697
    LANGUAGE sql
3698
    AS $_$
3699
SELECT util.eval(util.mk_set_search_path($1, $2))
3700
$_$;
3701

    
3702

    
3703
--
3704
-- Name: show_create_view(regclass); Type: FUNCTION; Schema: util; Owner: -
3705
--
3706

    
3707
CREATE FUNCTION show_create_view(view_ regclass) RETURNS text
3708
    LANGUAGE sql STABLE
3709
    AS $_$
3710
SELECT $$CREATE OR REPLACE VIEW $$||$1||$$ AS $$||pg_get_viewdef($1)||$$;
3711
$$||util.show_grants_for($1)
3712
$_$;
3713

    
3714

    
3715
--
3716
-- Name: show_grants_for(regclass); Type: FUNCTION; Schema: util; Owner: -
3717
--
3718

    
3719
CREATE FUNCTION show_grants_for(table_ regclass) RETURNS text
3720
    LANGUAGE sql STABLE
3721
    AS $_$
3722
SELECT string_agg(cmd, '')
3723
FROM
3724
(
3725
	SELECT (CASE WHEN has_table_privilege(user_, $1, 'SELECT') THEN
3726
$$GRANT SELECT ON TABLE $$||$1||$$ TO $$||quote_ident(user_)||$$;
3727
$$ ELSE '' END) AS cmd
3728
	FROM util.grants_users() f (user_)
3729
) s
3730
$_$;
3731

    
3732

    
3733
--
3734
-- Name: show_relations_like(text, text, character[]); Type: FUNCTION; Schema: util; Owner: -
3735
--
3736

    
3737
CREATE FUNCTION show_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, types character[] DEFAULT ARRAY['c'::text, 'r'::text, 'v'::text]) RETURNS SETOF regclass
3738
    LANGUAGE sql STABLE
3739
    AS $_$
3740
SELECT oid FROM pg_class
3741
WHERE relkind = ANY($3) AND relname ~ $1
3742
AND util.schema_matches(util.schema(relnamespace), $2)
3743
ORDER BY relname
3744
$_$;
3745

    
3746

    
3747
--
3748
-- Name: show_types_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3749
--
3750

    
3751
CREATE FUNCTION show_types_like(name_regexp text DEFAULT ''::text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regtype
3752
    LANGUAGE sql STABLE
3753
    AS $_$
3754
SELECT oid
3755
FROM pg_type
3756
WHERE typname ~ $1 AND util.schema_matches(util.schema(typnamespace), $2)
3757
ORDER BY typname
3758
$_$;
3759

    
3760

    
3761
--
3762
-- Name: show_views_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3763
--
3764

    
3765
CREATE FUNCTION show_views_like(name_regexp text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regclass
3766
    LANGUAGE sql STABLE
3767
    AS $_$
3768
SELECT * FROM util.show_relations_like($1, $2, ARRAY['v'])
3769
$_$;
3770

    
3771

    
3772
--
3773
-- Name: str_equality_regexp(text); Type: FUNCTION; Schema: util; Owner: -
3774
--
3775

    
3776
CREATE FUNCTION str_equality_regexp(literal text) RETURNS text
3777
    LANGUAGE sql IMMUTABLE
3778
    AS $_$
3779
SELECT '^'||util.regexp_quote($1)||'$'
3780
$_$;
3781

    
3782

    
3783
--
3784
-- Name: table2hstore(regclass); Type: FUNCTION; Schema: util; Owner: -
3785
--
3786

    
3787
CREATE FUNCTION table2hstore(table_ regclass) RETURNS hstore
3788
    LANGUAGE plpgsql STABLE STRICT
3789
    AS $_$
3790
DECLARE
3791
    hstore hstore;
3792
BEGIN
3793
    EXECUTE $$SELECT hstore(ARRAY(SELECT unnest(ARRAY["from", "to"]) FROM $$||
3794
        table_||$$))$$ INTO STRICT hstore;
3795
    RETURN hstore;
3796
END;
3797
$_$;
3798

    
3799

    
3800
--
3801
-- Name: table_flag__get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3802
--
3803

    
3804
CREATE FUNCTION table_flag__get(table_ regclass, flag text) RETURNS boolean
3805
    LANGUAGE sql STABLE
3806
    AS $_$
3807
SELECT COUNT(*) > 0 FROM pg_constraint
3808
WHERE conrelid = $1 AND contype = 'c' AND conname = $2
3809
$_$;
3810

    
3811

    
3812
--
3813
-- Name: FUNCTION table_flag__get(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3814
--
3815

    
3816
COMMENT ON FUNCTION table_flag__get(table_ regclass, flag text) IS '
3817
gets whether a status flag is set by the presence of a table constraint
3818
';
3819

    
3820

    
3821
--
3822
-- Name: table_flag__set(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3823
--
3824

    
3825
CREATE FUNCTION table_flag__set(table_ regclass, flag text) RETURNS void
3826
    LANGUAGE sql
3827
    AS $_$
3828
SELECT util.create_if_not_exists($$ALTER TABLE $$||$1||$$ ADD CONSTRAINT $$
3829
||quote_ident($2)||$$ CHECK (true)$$)
3830
$_$;
3831

    
3832

    
3833
--
3834
-- Name: FUNCTION table_flag__set(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3835
--
3836

    
3837
COMMENT ON FUNCTION table_flag__set(table_ regclass, flag text) IS '
3838
stores a status flag by the presence of a table constraint.
3839
idempotent.
3840
';
3841

    
3842

    
3843
--
3844
-- Name: table_nulls_mapped__get(regclass); Type: FUNCTION; Schema: util; Owner: -
3845
--
3846

    
3847
CREATE FUNCTION table_nulls_mapped__get(table_ regclass) RETURNS boolean
3848
    LANGUAGE sql STABLE
3849
    AS $_$
3850
SELECT util.table_flag__get($1, 'nulls_mapped')
3851
$_$;
3852

    
3853

    
3854
--
3855
-- Name: FUNCTION table_nulls_mapped__get(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3856
--
3857

    
3858
COMMENT ON FUNCTION table_nulls_mapped__get(table_ regclass) IS '
3859
gets whether a table''s NULL-equivalent strings have been replaced with NULL
3860
';
3861

    
3862

    
3863
--
3864
-- Name: table_nulls_mapped__set(regclass); Type: FUNCTION; Schema: util; Owner: -
3865
--
3866

    
3867
CREATE FUNCTION table_nulls_mapped__set(table_ regclass) RETURNS void
3868
    LANGUAGE sql
3869
    AS $_$
3870
SELECT util.table_flag__set($1, 'nulls_mapped')
3871
$_$;
3872

    
3873

    
3874
--
3875
-- Name: FUNCTION table_nulls_mapped__set(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3876
--
3877

    
3878
COMMENT ON FUNCTION table_nulls_mapped__set(table_ regclass) IS '
3879
sets that a table''s NULL-equivalent strings have been replaced with NULL.
3880
idempotent.
3881
';
3882

    
3883

    
3884
--
3885
-- Name: to_freq(regclass); Type: FUNCTION; Schema: util; Owner: -
3886
--
3887

    
3888
CREATE FUNCTION to_freq(table_ regclass) RETURNS void
3889
    LANGUAGE sql
3890
    AS $_$
3891
-- save data before truncating main table
3892
SELECT util.copy_types_and_data($1, 'pg_temp.__copy');
3893

    
3894
-- repopulate main table w/ copies column
3895
SELECT util.truncate($1);
3896
SELECT util.eval($$ALTER TABLE $$||$1||$$ ADD COLUMN copies bigint NOT NULL$$);
3897
SELECT util.populate_table($1, $$
3898
SELECT (table_).*, copies
3899
FROM (
3900
	SELECT table_, COUNT(*) AS copies
3901
	FROM pg_temp.__copy table_
3902
	GROUP BY table_
3903
) s
3904
$$);
3905

    
3906
-- delete temp table so it doesn't stay around until end of connection
3907
SELECT util.drop_table('pg_temp.__copy');
3908
$_$;
3909

    
3910

    
3911
--
3912
-- Name: to_global_col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
3913
--
3914

    
3915
CREATE FUNCTION to_global_col_names(table_ regclass) RETURNS void
3916
    LANGUAGE plpgsql STRICT
3917
    AS $_$
3918
DECLARE
3919
    row record;
3920
BEGIN
3921
    FOR row IN SELECT * FROM util.col_global_names(table_::text::regtype)
3922
    LOOP
3923
        IF row.global_name != row.name THEN
3924
            EXECUTE $$ALTER TABLE $$||table_||$$ RENAME $$
3925
                ||quote_ident(row.name)||$$ TO $$||quote_ident(row.global_name);
3926
        END IF;
3927
    END LOOP;
3928
END;
3929
$_$;
3930

    
3931

    
3932
--
3933
-- Name: FUNCTION to_global_col_names(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3934
--
3935

    
3936
COMMENT ON FUNCTION to_global_col_names(table_ regclass) IS '
3937
idempotent
3938
';
3939

    
3940

    
3941
--
3942
-- Name: trim(regclass, regclass, boolean); Type: FUNCTION; Schema: util; Owner: -
3943
--
3944

    
3945
CREATE FUNCTION "trim"(table_ regclass, names regclass, force boolean DEFAULT true) RETURNS void
3946
    LANGUAGE sql
3947
    AS $_$
3948
SELECT util.drop_column(($1, col), $3) FROM util.added_cols($1, $2) f (col);
3949
SELECT NULL::void; -- don't fold away functions called in previous query
3950
$_$;
3951

    
3952

    
3953
--
3954
-- Name: FUNCTION "trim"(table_ regclass, names regclass, force boolean); Type: COMMENT; Schema: util; Owner: -
3955
--
3956

    
3957
COMMENT ON FUNCTION "trim"(table_ regclass, names regclass, force boolean) IS '
3958
trims table_ to include only columns in the original data
3959

    
3960
by default, cascadingly drops dependent columns so that they don''t prevent
3961
trim() from succeeding. note that this requires the dependent columns to then be
3962
manually re-created.
3963

    
3964
idempotent
3965
';
3966

    
3967

    
3968
--
3969
-- Name: truncate(regclass); Type: FUNCTION; Schema: util; Owner: -
3970
--
3971

    
3972
CREATE FUNCTION truncate(table_ regclass) RETURNS void
3973
    LANGUAGE plpgsql STRICT
3974
    AS $_$
3975
BEGIN
3976
    EXECUTE $$TRUNCATE $$||table_||$$ CASCADE$$;
3977
END;
3978
$_$;
3979

    
3980

    
3981
--
3982
-- Name: FUNCTION truncate(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3983
--
3984

    
3985
COMMENT ON FUNCTION truncate(table_ regclass) IS '
3986
idempotent
3987
';
3988

    
3989

    
3990
--
3991
-- Name: truncated_prefixed_name_regexp(text, integer); Type: FUNCTION; Schema: util; Owner: -
3992
--
3993

    
3994
CREATE FUNCTION truncated_prefixed_name_regexp(name text, max_prefix_len integer) RETURNS text
3995
    LANGUAGE sql IMMUTABLE
3996
    AS $_$
3997
SELECT '^(.*)'||util._if(util.name_was_truncated($1, $2),
3998
util.regexp_quote(util.rtrim_n($1, $2))||'.*', util.regexp_quote($1)) ||'$'
3999
$_$;
4000

    
4001

    
4002
--
4003
-- Name: try_cast(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
4004
--
4005

    
4006
CREATE FUNCTION try_cast(value text, ret_type_null anyelement) RETURNS anyelement
4007
    LANGUAGE plpgsql IMMUTABLE
4008
    AS $$
4009
BEGIN
4010
	/* need explicit cast because some types not implicitly-castable, and also
4011
	to make the cast happen inside the try block. (*implicit* casts to the
4012
	return type happen at the end of the function, outside any block.) */
4013
	RETURN util.cast(value, ret_type_null);
4014
EXCEPTION
4015
WHEN data_exception THEN
4016
	PERFORM util.raise('WARNING', SQLERRM);
4017
	RETURN NULL;
4018
END;
4019
$$;
4020

    
4021

    
4022
--
4023
-- Name: FUNCTION try_cast(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
4024
--
4025

    
4026
COMMENT ON FUNCTION try_cast(value text, ret_type_null anyelement) IS '
4027
ret_type_null: NULL::ret_type
4028
';
4029

    
4030

    
4031
--
4032
-- Name: try_create(text); Type: FUNCTION; Schema: util; Owner: -
4033
--
4034

    
4035
CREATE FUNCTION try_create(sql text) RETURNS void
4036
    LANGUAGE plpgsql STRICT
4037
    AS $$
4038
BEGIN
4039
	PERFORM util.eval(sql);
4040
EXCEPTION
4041
WHEN   not_null_violation
4042
		/* trying to add NOT NULL column to parent table, which cascades to
4043
		child table whose values for the new column will be NULL */
4044
	OR wrong_object_type -- trying to alter a view's columns
4045
	OR undefined_column
4046
	OR duplicate_column
4047
THEN NULL;
4048
WHEN datatype_mismatch THEN
4049
	IF SQLERRM LIKE 'child table is missing column %' THEN NULL;
4050
	ELSE RAISE; -- rethrow
4051
	END IF;
4052
END;
4053
$$;
4054

    
4055

    
4056
--
4057
-- Name: FUNCTION try_create(sql text); Type: COMMENT; Schema: util; Owner: -
4058
--
4059

    
4060
COMMENT ON FUNCTION try_create(sql text) IS '
4061
idempotent
4062
';
4063

    
4064

    
4065
--
4066
-- Name: try_mk_derived_col(col_ref, text); Type: FUNCTION; Schema: util; Owner: -
4067
--
4068

    
4069
CREATE FUNCTION try_mk_derived_col(col col_ref, expr text) RETURNS void
4070
    LANGUAGE sql
4071
    AS $_$
4072
SELECT util.try_create($$SELECT util.mk_derived_col($$||quote_literal($1)||$$, $$||quote_literal($2)||$$)$$)
4073
$_$;
4074

    
4075

    
4076
--
4077
-- Name: FUNCTION try_mk_derived_col(col col_ref, expr text); Type: COMMENT; Schema: util; Owner: -
4078
--
4079

    
4080
COMMENT ON FUNCTION try_mk_derived_col(col col_ref, expr text) IS '
4081
idempotent
4082
';
4083

    
4084

    
4085
--
4086
-- Name: type_qual(anyelement); Type: FUNCTION; Schema: util; Owner: -
4087
--
4088

    
4089
CREATE FUNCTION type_qual(value anyelement) RETURNS text
4090
    LANGUAGE sql IMMUTABLE
4091
    AS $_$
4092
SELECT CASE WHEN $1 IS NULL THEN '' ELSE $$ NOT NULL$$ END
4093
$_$;
4094

    
4095

    
4096
--
4097
-- Name: FUNCTION type_qual(value anyelement); Type: COMMENT; Schema: util; Owner: -
4098
--
4099

    
4100
COMMENT ON FUNCTION type_qual(value anyelement) IS '
4101
a type''s NOT NULL qualifier
4102
';
4103

    
4104

    
4105
--
4106
-- Name: typed_cols(regtype); Type: FUNCTION; Schema: util; Owner: -
4107
--
4108

    
4109
CREATE FUNCTION typed_cols(type regtype) RETURNS SETOF col_cast
4110
    LANGUAGE sql STABLE
4111
    AS $_$
4112
SELECT (attname::text, atttypid)::util.col_cast
4113
FROM pg_attribute
4114
WHERE attrelid = $1::text::regclass AND attnum >= 1 AND NOT attisdropped
4115
ORDER BY attnum
4116
$_$;
4117

    
4118

    
4119
--
4120
-- Name: typeof(anyelement); Type: FUNCTION; Schema: util; Owner: -
4121
--
4122

    
4123
CREATE FUNCTION typeof(value anyelement) RETURNS text
4124
    LANGUAGE sql IMMUTABLE
4125
    AS $_$
4126
SELECT util.qual_name(pg_typeof($1))
4127
$_$;
4128

    
4129

    
4130
--
4131
-- Name: typeof(text, regtype); Type: FUNCTION; Schema: util; Owner: -
4132
--
4133

    
4134
CREATE FUNCTION typeof(expr text, table_ regtype DEFAULT NULL::regtype) RETURNS regtype
4135
    LANGUAGE plpgsql STABLE
4136
    AS $_$
4137
DECLARE
4138
    type regtype;
4139
BEGIN
4140
    EXECUTE $$SELECT pg_typeof($$||expr||$$)$$||
4141
COALESCE($$ FROM (SELECT (NULL::$$||table_||$$).*) _s$$, '') INTO STRICT type;
4142
    RETURN type;
4143
END;
4144
$_$;
4145

    
4146

    
4147
--
4148
-- Name: use_schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
4149
--
4150

    
4151
CREATE FUNCTION use_schema(schema_anchor anyelement) RETURNS void
4152
    LANGUAGE sql
4153
    AS $_$
4154
SELECT util.set_search_path(util.mk_search_path(util.schema($1)))
4155
$_$;
4156

    
4157

    
4158
--
4159
-- Name: FUNCTION use_schema(schema_anchor anyelement); Type: COMMENT; Schema: util; Owner: -
4160
--
4161

    
4162
COMMENT ON FUNCTION use_schema(schema_anchor anyelement) IS '
4163
auto-appends util to the search_path to enable use of util operators
4164
';
4165

    
4166

    
4167
--
4168
-- Name: all_same(anyelement); Type: AGGREGATE; Schema: util; Owner: -
4169
--
4170

    
4171
CREATE AGGREGATE all_same(anyelement) (
4172
    SFUNC = all_same_transform,
4173
    STYPE = anyarray,
4174
    FINALFUNC = all_same_final
4175
);
4176

    
4177

    
4178
--
4179
-- Name: AGGREGATE all_same(anyelement); Type: COMMENT; Schema: util; Owner: -
4180
--
4181

    
4182
COMMENT ON AGGREGATE all_same(anyelement) IS '
4183
includes NULLs in comparison
4184
';
4185

    
4186

    
4187
--
4188
-- Name: join_strs(text, text); Type: AGGREGATE; Schema: util; Owner: -
4189
--
4190

    
4191
CREATE AGGREGATE join_strs(text, text) (
4192
    SFUNC = join_strs_transform,
4193
    STYPE = text
4194
);
4195

    
4196

    
4197
--
4198
-- Name: %==; Type: OPERATOR; Schema: util; Owner: -
4199
--
4200

    
4201
CREATE OPERATOR %== (
4202
    PROCEDURE = "%==",
4203
    LEFTARG = anyelement,
4204
    RIGHTARG = anyelement
4205
);
4206

    
4207

    
4208
--
4209
-- Name: OPERATOR %== (anyelement, anyelement); Type: COMMENT; Schema: util; Owner: -
4210
--
4211

    
4212
COMMENT ON OPERATOR %== (anyelement, anyelement) IS '
4213
returns whether the map-keys of the compared values are the same
4214
(mnemonic: % is the Perl symbol for a hash map)
4215

    
4216
should be overridden for types that store both keys and values
4217

    
4218
used in a FULL JOIN to select which columns to join on
4219
';
4220

    
4221

    
4222
--
4223
-- Name: ->; Type: OPERATOR; Schema: util; Owner: -
4224
--
4225

    
4226
CREATE OPERATOR -> (
4227
    PROCEDURE = map_get,
4228
    LEFTARG = regclass,
4229
    RIGHTARG = text
4230
);
4231

    
4232

    
4233
--
4234
-- Name: =>; Type: OPERATOR; Schema: util; Owner: -
4235
--
4236

    
4237
CREATE OPERATOR => (
4238
    PROCEDURE = hstore,
4239
    LEFTARG = text[],
4240
    RIGHTARG = text
4241
);
4242

    
4243

    
4244
--
4245
-- Name: OPERATOR => (text[], text); Type: COMMENT; Schema: util; Owner: -
4246
--
4247

    
4248
COMMENT ON OPERATOR => (text[], text) IS '
4249
usage: array[''key1'', ...]::text[] => ''value''
4250
';
4251

    
4252

    
4253
--
4254
-- Name: ?*>=; Type: OPERATOR; Schema: util; Owner: -
4255
--
4256

    
4257
CREATE OPERATOR ?*>= (
4258
    PROCEDURE = is_populated_more_often_than,
4259
    LEFTARG = anyelement,
4260
    RIGHTARG = anyelement
4261
);
4262

    
4263

    
4264
--
4265
-- Name: ?>=; Type: OPERATOR; Schema: util; Owner: -
4266
--
4267

    
4268
CREATE OPERATOR ?>= (
4269
    PROCEDURE = is_more_complete_than,
4270
    LEFTARG = anyelement,
4271
    RIGHTARG = anyelement
4272
);
4273

    
4274

    
4275
--
4276
-- Name: ||%; Type: OPERATOR; Schema: util; Owner: -
4277
--
4278

    
4279
CREATE OPERATOR ||% (
4280
    PROCEDURE = concat_esc,
4281
    LEFTARG = text,
4282
    RIGHTARG = text
4283
);
4284

    
4285

    
4286
--
4287
-- Name: OPERATOR ||% (text, text); Type: COMMENT; Schema: util; Owner: -
4288
--
4289

    
4290
COMMENT ON OPERATOR ||% (text, text) IS '
4291
% indicates an identifier, as in Perl hashes and one of the x86 assembler syntaxes for registers
4292
';
4293

    
4294

    
4295
--
4296
-- Name: map; Type: TABLE; Schema: util; Owner: -; Tablespace: 
4297
--
4298

    
4299
CREATE TABLE map (
4300
    "from" text NOT NULL,
4301
    "to" text,
4302
    filter text,
4303
    notes text
4304
);
4305

    
4306

    
4307
--
4308
-- Data for Name: explain; Type: TABLE DATA; Schema: util; Owner: -
4309
--
4310

    
4311

    
4312

    
4313
--
4314
-- Data for Name: map; Type: TABLE DATA; Schema: util; Owner: -
4315
--
4316

    
4317

    
4318

    
4319
--
4320
-- Name: map__unique__from; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
4321
--
4322

    
4323
ALTER TABLE ONLY map
4324
    ADD CONSTRAINT map__unique__from UNIQUE ("from");
4325

    
4326

    
4327
--
4328
-- Name: map__unique__to; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
4329
--
4330

    
4331
ALTER TABLE ONLY map
4332
    ADD CONSTRAINT map__unique__to UNIQUE ("to");
4333

    
4334

    
4335
--
4336
-- Name: map_filter_insert; Type: TRIGGER; Schema: util; Owner: -
4337
--
4338

    
4339
CREATE TRIGGER map_filter_insert BEFORE INSERT ON map FOR EACH ROW EXECUTE PROCEDURE map_filter_insert();
4340

    
4341

    
4342
--
4343
-- PostgreSQL database dump complete
4344
--
4345

    
(21-21/31)