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: _label(text, text); Type: FUNCTION; Schema: util; Owner: -
272
--
273

    
274
CREATE FUNCTION _label(label text, value text) RETURNS text
275
    LANGUAGE sql IMMUTABLE
276
    AS $_$
277
SELECT coalesce($1 || ': ', '') || $2
278
$_$;
279

    
280

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

    
285
CREATE FUNCTION _lowercase(value text) RETURNS text
286
    LANGUAGE sql IMMUTABLE
287
    AS $_$
288
SELECT lower($1)
289
$_$;
290

    
291

    
292
--
293
-- Name: _map(hstore, anyelement); Type: FUNCTION; Schema: util; Owner: -
294
--
295

    
296
CREATE FUNCTION _map(map hstore, value anyelement) RETURNS anyelement
297
    LANGUAGE plpgsql IMMUTABLE STRICT
298
    AS $$
299
DECLARE
300
    result value%TYPE := util._map(map, value::text)::unknown;
301
BEGIN
302
    RETURN result;
303
END;
304
$$;
305

    
306

    
307
--
308
-- Name: _map(hstore, text); Type: FUNCTION; Schema: util; Owner: -
309
--
310

    
311
CREATE FUNCTION _map(map hstore, value text) RETURNS text
312
    LANGUAGE plpgsql IMMUTABLE STRICT
313
    AS $$
314
DECLARE
315
    match text := map -> value;
316
BEGIN
317
    IF match IS NULL AND NOT map ? value THEN -- no match rather than NULL match
318
        match := map -> '*'; -- use default entry
319
        IF match IS NULL AND NOT map ? '*' THEN match := '!'; -- no default
320
        END IF;
321
    END IF;
322
    
323
    -- Interpret result
324
    IF match = '!' THEN RAISE 'Value not in map: %', value USING ERRCODE = 'data_exception';
325
    ELSIF match = '*' THEN RETURN value;
326
    ELSE RETURN match;
327
    END IF;
328
END;
329
$$;
330

    
331

    
332
--
333
-- Name: _max(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
334
--
335

    
336
CREATE FUNCTION _max("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
337
    LANGUAGE sql IMMUTABLE
338
    AS $_$
339
SELECT GREATEST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
340
$_$;
341

    
342

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

    
347
CREATE FUNCTION _merge("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
348
    LANGUAGE sql IMMUTABLE
349
    AS $_$
350
SELECT util.join_strs(value, '; ')
351
FROM
352
(
353
    SELECT *
354
    FROM
355
    (
356
        SELECT
357
        DISTINCT ON (value)
358
        *
359
        FROM
360
        (VALUES
361
              (1, $1)
362
            , (2, $2)
363
            , (3, $3)
364
            , (4, $4)
365
            , (5, $5)
366
            , (6, $6)
367
            , (7, $7)
368
            , (8, $8)
369
            , (9, $9)
370
            , (10, $10)
371
        )
372
        AS v (sort_order, value)
373
        WHERE value IS NOT NULL
374
    )
375
    AS v
376
    ORDER BY sort_order
377
)
378
AS v
379
$_$;
380

    
381

    
382
--
383
-- Name: _merge_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
384
--
385

    
386
CREATE FUNCTION _merge_prefix(prefix text DEFAULT NULL::text, value text DEFAULT NULL::text) RETURNS text
387
    LANGUAGE sql IMMUTABLE
388
    AS $_$
389
SELECT _join_words((CASE WHEN $2 ~ ('^'||$1||E'\\y') THEN NULL ELSE $1 END), $2)
390
$_$;
391

    
392

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

    
397
CREATE FUNCTION _merge_words("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
398
    LANGUAGE sql IMMUTABLE
399
    AS $_$
400
SELECT util.join_strs(value, ' ')
401
FROM
402
(
403
    SELECT *
404
    FROM
405
    (
406
        SELECT
407
        DISTINCT ON (value)
408
        *
409
        FROM
410
        (VALUES
411
              (1, $1)
412
            , (2, $2)
413
            , (3, $3)
414
            , (4, $4)
415
            , (5, $5)
416
            , (6, $6)
417
            , (7, $7)
418
            , (8, $8)
419
            , (9, $9)
420
            , (10, $10)
421
        )
422
        AS v (sort_order, value)
423
        WHERE value IS NOT NULL
424
    )
425
    AS v
426
    ORDER BY sort_order
427
)
428
AS v
429
$_$;
430

    
431

    
432
--
433
-- Name: _min(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
434
--
435

    
436
CREATE FUNCTION _min("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
437
    LANGUAGE sql IMMUTABLE
438
    AS $_$
439
SELECT LEAST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
440
$_$;
441

    
442

    
443
--
444
-- Name: _not(boolean); Type: FUNCTION; Schema: util; Owner: -
445
--
446

    
447
CREATE FUNCTION _not(value boolean) RETURNS boolean
448
    LANGUAGE sql IMMUTABLE
449
    AS $_$
450
SELECT NOT $1
451
$_$;
452

    
453

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

    
458
CREATE FUNCTION _now() RETURNS timestamp with time zone
459
    LANGUAGE sql STABLE
460
    AS $$
461
SELECT now()
462
$$;
463

    
464

    
465
--
466
-- Name: _nullIf(anyelement, text, text); Type: FUNCTION; Schema: util; Owner: -
467
--
468

    
469
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type text) RETURNS anyelement
470
    LANGUAGE sql IMMUTABLE
471
    AS $_$
472
SELECT util."_nullIf"($1, $2, $3::util.datatype)
473
$_$;
474

    
475

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

    
480
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type datatype DEFAULT 'str'::datatype) RETURNS anyelement
481
    LANGUAGE plpgsql IMMUTABLE
482
    AS $$
483
DECLARE
484
    type util.datatype NOT NULL := type; -- add NOT NULL
485
BEGIN
486
    IF type = 'str' THEN RETURN nullif(value::text, "null");
487
    -- Invalid value is ignored, but invalid null value generates error
488
    ELSIF type = 'float' THEN
489
        DECLARE
490
            -- Outside the try block so that invalid null value generates error
491
            "null" double precision := "null"::double precision;
492
        BEGIN
493
            RETURN nullif(value::double precision, "null");
494
        EXCEPTION
495
            WHEN data_exception THEN RETURN value; -- ignore invalid value
496
        END;
497
    END IF;
498
END;
499
$$;
500

    
501

    
502
--
503
-- Name: _or(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
504
--
505

    
506
CREATE FUNCTION _or("0" boolean DEFAULT NULL::boolean, "1" boolean DEFAULT NULL::boolean, "2" boolean DEFAULT NULL::boolean, "3" boolean DEFAULT NULL::boolean, "4" boolean DEFAULT NULL::boolean) RETURNS boolean
507
    LANGUAGE sql IMMUTABLE
508
    AS $_$
509
SELECT bool_or(value)
510
FROM
511
(VALUES
512
      ($1)
513
    , ($2)
514
    , ($3)
515
    , ($4)
516
    , ($5)
517
)
518
AS v (value)
519
$_$;
520

    
521

    
522
--
523
-- Name: FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
524
--
525

    
526
COMMENT ON FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
527
_or() ignores NULL values, while OR combines them with the other values to potentially convert false to NULL. OR should be used with required fields, and _or() with optional fields.
528
';
529

    
530

    
531
--
532
-- Name: _range(double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
533
--
534

    
535
CREATE FUNCTION _range("from" double precision DEFAULT NULL::double precision, "to" double precision DEFAULT NULL::double precision) RETURNS double precision
536
    LANGUAGE sql IMMUTABLE
537
    AS $_$
538
SELECT $2 - $1
539
$_$;
540

    
541

    
542
--
543
-- Name: _split(text, text); Type: FUNCTION; Schema: util; Owner: -
544
--
545

    
546
CREATE FUNCTION _split(value text DEFAULT NULL::text, separator text DEFAULT '; '::text) RETURNS SETOF text
547
    LANGUAGE sql IMMUTABLE
548
    AS $_$
549
SELECT regexp_split_to_table($1, $2)
550
$_$;
551

    
552

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

    
557
CREATE FUNCTION added_cols(table_ regclass, names regclass) RETURNS SETOF text
558
    LANGUAGE sql STABLE
559
    AS $_$
560
SELECT util.derived_cols($1, $2)
561
UNION
562
SELECT util.eval2set($$
563
SELECT col
564
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
565
JOIN $$||$2||$$ ON "to" = col
566
WHERE "from" LIKE ':%'
567
$$, NULL::text)
568
$_$;
569

    
570

    
571
--
572
-- Name: FUNCTION added_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
573
--
574

    
575
COMMENT ON FUNCTION added_cols(table_ regclass, names regclass) IS '
576
gets table_''s added columns (all the columns not in the original data)
577
';
578

    
579

    
580
--
581
-- Name: all_same_final(anyarray); Type: FUNCTION; Schema: util; Owner: -
582
--
583

    
584
CREATE FUNCTION all_same_final(state anyarray) RETURNS boolean
585
    LANGUAGE sql IMMUTABLE
586
    AS $_$
587
SELECT $1 IS NULL/*no rows*/ OR util.not_empty($1)/*not no_match_sentinel*/
588
$_$;
589

    
590

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

    
595
CREATE FUNCTION all_same_transform(state anyarray, value anyelement) RETURNS anyarray
596
    LANGUAGE plpgsql IMMUTABLE
597
    AS $$
598
DECLARE
599
	value_cmp         state%TYPE = ARRAY[value];
600
	state             state%TYPE = COALESCE(state, value_cmp);
601
	no_match_sentinel state%TYPE = value_cmp[1:0]/*=ARRAY[]::state%TYPE*/;
602
BEGIN
603
	RETURN (CASE WHEN value_cmp IS NOT DISTINCT FROM state THEN state ELSE no_match_sentinel END);
604
END;
605
$$;
606

    
607

    
608
--
609
-- Name: analyze_(regclass); Type: FUNCTION; Schema: util; Owner: -
610
--
611

    
612
CREATE FUNCTION analyze_(table_ regclass) RETURNS void
613
    LANGUAGE sql
614
    AS $_$
615
SELECT util.eval($$ANALYZE VERBOSE $$||$1)
616
$_$;
617

    
618

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

    
623
CREATE FUNCTION append_comment(table_ regclass, comment text) RETURNS void
624
    LANGUAGE sql
625
    AS $_$
626
SELECT util.set_comment($1, concat(util.comment($1), $2))
627
$_$;
628

    
629

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

    
634
COMMENT ON FUNCTION append_comment(table_ regclass, comment text) IS '
635
comment: must start and end with a newline
636
';
637

    
638

    
639
--
640
-- Name: array_fill(anyelement, integer); Type: FUNCTION; Schema: util; Owner: -
641
--
642

    
643
CREATE FUNCTION array_fill(value anyelement, length integer) RETURNS anyarray
644
    LANGUAGE sql IMMUTABLE
645
    AS $_$
646
SELECT pg_catalog.array_fill($1, ARRAY[$2])
647
$_$;
648

    
649

    
650
--
651
-- Name: array_length(anyarray); Type: FUNCTION; Schema: util; Owner: -
652
--
653

    
654
CREATE FUNCTION array_length("array" anyarray) RETURNS integer
655
    LANGUAGE sql IMMUTABLE
656
    AS $_$
657
SELECT util.array_length($1, 1)
658
$_$;
659

    
660

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

    
665
CREATE FUNCTION array_length("array" anyarray, dimension integer) RETURNS integer
666
    LANGUAGE sql IMMUTABLE
667
    AS $_$
668
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE COALESCE(pg_catalog.array_length($1, $2), 0) END
669
$_$;
670

    
671

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

    
676
COMMENT ON FUNCTION array_length("array" anyarray, dimension integer) IS '
677
returns 0 instead of NULL for empty arrays
678
';
679

    
680

    
681
--
682
-- Name: cluster_index(regclass); Type: FUNCTION; Schema: util; Owner: -
683
--
684

    
685
CREATE FUNCTION cluster_index(table_ regclass) RETURNS regclass
686
    LANGUAGE sql STABLE
687
    AS $_$
688
SELECT indexrelid FROM pg_index WHERE indrelid = $1 AND indisclustered
689
$_$;
690

    
691

    
692
--
693
-- Name: cluster_once(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
694
--
695

    
696
CREATE FUNCTION cluster_once(table_ regclass, index regclass) RETURNS void
697
    LANGUAGE plpgsql STRICT
698
    AS $_$
699
BEGIN
700
    -- not yet clustered (ARRAY[] compares NULLs literally)
701
    IF ARRAY[util.cluster_index(table_)] != ARRAY[index] THEN
702
        EXECUTE $$CLUSTER $$||table_||$$ USING $$||index;
703
    END IF;
704
END;
705
$_$;
706

    
707

    
708
--
709
-- Name: FUNCTION cluster_once(table_ regclass, index regclass); Type: COMMENT; Schema: util; Owner: -
710
--
711

    
712
COMMENT ON FUNCTION cluster_once(table_ regclass, index regclass) IS '
713
idempotent
714
';
715

    
716

    
717
--
718
-- Name: col__min(col_ref); Type: FUNCTION; Schema: util; Owner: -
719
--
720

    
721
CREATE FUNCTION col__min(col col_ref) RETURNS integer
722
    LANGUAGE sql STABLE
723
    AS $_$
724
SELECT util.eval2val($$
725
SELECT $$||quote_ident($1.name)||$$
726
FROM $$||$1.table_||$$
727
ORDER BY $$||quote_ident($1.name)||$$ ASC
728
LIMIT 1
729
$$, NULL::integer)
730
$_$;
731

    
732

    
733
--
734
-- Name: col_comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
735
--
736

    
737
CREATE FUNCTION col_comment(col col_ref) RETURNS text
738
    LANGUAGE plpgsql STABLE STRICT
739
    AS $$
740
DECLARE
741
	comment text;
742
BEGIN
743
	SELECT description
744
	FROM pg_attribute
745
	LEFT JOIN pg_description ON objoid = attrelid
746
		AND classoid = 'pg_class'::regclass AND objsubid = attnum
747
	WHERE attrelid = col.table_ AND attname = col.name
748
	INTO STRICT comment
749
	;
750
	RETURN comment;
751
EXCEPTION
752
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
753
END;
754
$$;
755

    
756

    
757
--
758
-- Name: col_default_sql(col_ref); Type: FUNCTION; Schema: util; Owner: -
759
--
760

    
761
CREATE FUNCTION col_default_sql(col col_ref) RETURNS text
762
    LANGUAGE plpgsql STABLE STRICT
763
    AS $$
764
DECLARE
765
	default_sql text;
766
BEGIN
767
	SELECT adsrc
768
	FROM pg_attribute
769
	LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum
770
	WHERE attrelid = col.table_ AND attname = col.name
771
	INTO STRICT default_sql
772
	;
773
	RETURN default_sql;
774
EXCEPTION
775
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
776
END;
777
$$;
778

    
779

    
780
--
781
-- Name: col_default_value(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
782
--
783

    
784
CREATE FUNCTION col_default_value(col col_ref, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
785
    LANGUAGE sql STABLE
786
    AS $_$
787
SELECT util.eval_expr_passthru(util.col_default_sql($1), $2)
788
$_$;
789

    
790

    
791
--
792
-- Name: FUNCTION col_default_value(col col_ref, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
793
--
794

    
795
COMMENT ON FUNCTION col_default_value(col col_ref, ret_type_null anyelement) IS '
796
ret_type_null: NULL::ret_type
797
';
798

    
799

    
800
--
801
-- Name: col_exists(col_ref); Type: FUNCTION; Schema: util; Owner: -
802
--
803

    
804
CREATE FUNCTION col_exists(col col_ref) RETURNS boolean
805
    LANGUAGE plpgsql STRICT
806
    AS $$
807
BEGIN
808
    PERFORM util.col_type(col);
809
    RETURN true;
810
EXCEPTION
811
    WHEN undefined_column THEN RETURN false;
812
END;
813
$$;
814

    
815

    
816
--
817
-- Name: col_global_names(regtype); Type: FUNCTION; Schema: util; Owner: -
818
--
819

    
820
CREATE FUNCTION col_global_names(type regtype, OUT name text, OUT global_name text) RETURNS SETOF record
821
    LANGUAGE plpgsql STABLE STRICT
822
    AS $$
823
DECLARE
824
    prefix text := util.name(type)||'.';
825
BEGIN
826
    RETURN QUERY
827
        SELECT name_, (CASE WHEN util.contains(search_for:='.', in_str:=name_) THEN '' ELSE prefix END)||name_
828
        FROM util.col_names(type) f (name_);
829
END;
830
$$;
831

    
832

    
833
--
834
-- Name: col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
835
--
836

    
837
CREATE FUNCTION col_names(table_ regclass) RETURNS SETOF text
838
    LANGUAGE sql STABLE
839
    AS $_$
840
SELECT attname::text
841
FROM pg_attribute
842
WHERE attrelid = $1 AND attnum >= 1 AND NOT attisdropped
843
ORDER BY attnum
844
$_$;
845

    
846

    
847
--
848
-- Name: col_names(regtype); Type: FUNCTION; Schema: util; Owner: -
849
--
850

    
851
CREATE FUNCTION col_names(type regtype) RETURNS SETOF text
852
    LANGUAGE plpgsql STABLE STRICT
853
    AS $_$
854
BEGIN
855
    RETURN QUERY EXECUTE $$SELECT skeys(hstore(NULL::$$||type||$$))$$;
856
END;
857
$_$;
858

    
859

    
860
--
861
-- Name: col_type(col_ref); Type: FUNCTION; Schema: util; Owner: -
862
--
863

    
864
CREATE FUNCTION col_type(col col_ref) RETURNS regtype
865
    LANGUAGE plpgsql STABLE STRICT
866
    AS $$
867
DECLARE
868
    type regtype;
869
BEGIN
870
    SELECT atttypid FROM pg_attribute
871
    WHERE attrelid = col.table_ AND attname = col.name
872
    INTO STRICT type
873
    ;
874
    RETURN type;
875
EXCEPTION
876
    WHEN no_data_found THEN
877
        RAISE undefined_column USING MESSAGE =
878
            concat('undefined column: ', col.name);
879
END;
880
$$;
881

    
882

    
883
--
884
-- Name: comment(oid); Type: FUNCTION; Schema: util; Owner: -
885
--
886

    
887
CREATE FUNCTION comment(element oid) RETURNS text
888
    LANGUAGE sql STABLE
889
    AS $_$
890
SELECT description FROM pg_description WHERE objoid = $1
891
$_$;
892

    
893

    
894
--
895
-- Name: concat_esc(text, text); Type: FUNCTION; Schema: util; Owner: -
896
--
897

    
898
CREATE FUNCTION concat_esc("left" text, "right" text) RETURNS text
899
    LANGUAGE sql IMMUTABLE
900
    AS $_$
901
SELECT util.esc_name__append($2, $1)
902
$_$;
903

    
904

    
905
--
906
-- Name: contains(text, text); Type: FUNCTION; Schema: util; Owner: -
907
--
908

    
909
CREATE FUNCTION contains(search_for text, in_str text) RETURNS boolean
910
    LANGUAGE sql IMMUTABLE
911
    AS $_$
912
SELECT position($1 in $2) > 0 /*1-based offset*/
913
$_$;
914

    
915

    
916
--
917
-- Name: copy_struct(regclass, text); Type: FUNCTION; Schema: util; Owner: -
918
--
919

    
920
CREATE FUNCTION copy_struct(from_ regclass, to_ text) RETURNS void
921
    LANGUAGE sql
922
    AS $_$
923
SELECT util.eval($$CREATE TABLE $$||$2||$$ (LIKE $$||$1||$$ INCLUDING ALL)$$)
924
$_$;
925

    
926

    
927
--
928
-- Name: create_if_not_exists(text); Type: FUNCTION; Schema: util; Owner: -
929
--
930

    
931
CREATE FUNCTION create_if_not_exists(sql text) RETURNS void
932
    LANGUAGE plpgsql STRICT
933
    AS $$
934
BEGIN
935
    PERFORM util.eval(sql);
936
EXCEPTION
937
    WHEN duplicate_table  THEN NULL;
938
    WHEN duplicate_object THEN NULL; -- e.g. constraint
939
    WHEN duplicate_column THEN NULL;
940
    WHEN invalid_table_definition THEN
941
        IF SQLERRM LIKE 'multiple primary keys for table % are not allowed' THEN NULL;
942
        ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM; -- rethrow
943
        END IF;
944
END;
945
$$;
946

    
947

    
948
--
949
-- Name: FUNCTION create_if_not_exists(sql text); Type: COMMENT; Schema: util; Owner: -
950
--
951

    
952
COMMENT ON FUNCTION create_if_not_exists(sql text) IS '
953
idempotent
954
';
955

    
956

    
957
--
958
-- Name: curr_func(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
959
--
960

    
961
CREATE FUNCTION curr_func(func text, schema_anchor anyelement) RETURNS text
962
    LANGUAGE sql IMMUTABLE
963
    AS $$
964
SELECT util.schema_esc(schema_anchor)||'.'||quote_ident(func)
965
$$;
966

    
967

    
968
--
969
-- Name: debug_print_return_value(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
970
--
971

    
972
CREATE FUNCTION debug_print_return_value(value anyelement, encode boolean DEFAULT false) RETURNS anyelement
973
    LANGUAGE sql IMMUTABLE
974
    AS $_$
975
SELECT util.raise('NOTICE', 'returns: '
976
||(CASE WHEN $2 THEN util.quote_typed($1) ELSE $1::text END));
977
SELECT $1;
978
$_$;
979

    
980

    
981
--
982
-- Name: debug_print_sql(text); Type: FUNCTION; Schema: util; Owner: -
983
--
984

    
985
CREATE FUNCTION debug_print_sql(sql text) RETURNS void
986
    LANGUAGE sql IMMUTABLE
987
    AS $_$
988
/* newline before so the query starts at the beginning of the line.
989
newline after to visually separate queries from one another. */
990
SELECT util.raise('NOTICE', $$
991
$$||util.runnable_sql($1)||$$
992
$$||COALESCE(util.explain2notice_msg_if_can($1), ''))
993
$_$;
994

    
995

    
996
--
997
-- Name: derived_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
998
--
999

    
1000
CREATE FUNCTION derived_cols(table_ regclass, names regclass) RETURNS SETOF text
1001
    LANGUAGE sql STABLE
1002
    AS $_$
1003
SELECT util.eval2set($$
1004
SELECT col
1005
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
1006
LEFT JOIN $$||$2||$$ ON "to" = col
1007
WHERE "from" IS NULL
1008
$$, NULL::text)
1009
$_$;
1010

    
1011

    
1012
--
1013
-- Name: FUNCTION derived_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
1014
--
1015

    
1016
COMMENT ON FUNCTION derived_cols(table_ regclass, names regclass) IS '
1017
gets table_''s derived columns (all the columns not in the names table)
1018
';
1019

    
1020

    
1021
--
1022
-- Name: diff(regclass, regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
1023
--
1024

    
1025
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1026
    LANGUAGE sql
1027
    AS $_$
1028
SELECT * FROM util.diff($1::text, $2::text, $3,
1029
	single_row := util.has_single_row($1) AND util.has_single_row($2))
1030
$_$;
1031

    
1032

    
1033
--
1034
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1035
--
1036

    
1037
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1038
col_type_null (*required*): NULL::shared_base_type
1039
usage:
1040
SELECT * FROM util.diff(''"left_table"''::regclass, ''"right_table"''::regclass, NULL::shared_base_type)
1041
';
1042

    
1043

    
1044
--
1045
-- Name: diff(text, text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1046
--
1047

    
1048
CREATE FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean DEFAULT false, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1049
    LANGUAGE plpgsql
1050
    SET search_path TO pg_temp
1051
    AS $_$
1052
/* must use LANGUAGE plpgsql because LANGUAGE sql does not support runtime
1053
changes of search_path (schema elements are bound at inline time rather than
1054
runtime) */
1055
/* function option search_path is needed to limit the effects of
1056
`SET LOCAL search_path` to the current function */
1057
BEGIN
1058
	PERFORM util.use_schema($3); -- includes util.%== as default/fallback
1059
	
1060
	RETURN QUERY
1061
		SELECT * FROM util.eval2col_pair(util.mk_diff_query($1, $2, false,
1062
$$/* need to explicitly cast each side to the return type because this does not
1063
happen automatically even when an implicit cast is available */
1064
  left_::$$||util.typeof($3)||$$
1065
, right_::$$||util.typeof($3)
1066
/* when using the util.%==(anyelement, anyelement) operator, you must cast to
1067
the *same* base type, *even though* this is optional when using a custom %== */
1068
, util._if($4, $$true/*= CROSS JOIN*/$$,
1069
$$ left_::$$||util.typeof($3)||$$
1070
%== right_::$$||util.typeof($3)||$$
1071
	-- refer to EXPLAIN output for expansion of %==$$
1072
)), $3)
1073
	;
1074
END;
1075
$_$;
1076

    
1077

    
1078
--
1079
-- 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: -
1080
--
1081

    
1082
COMMENT ON FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1083
col_type_null (*required*): NULL::col_type
1084
single_row: whether the tables consist of a single row, which should be
1085
	displayed side-by-side
1086

    
1087
to match up rows using a subset of the columns, create a custom keys() function
1088
which returns this subset as a record:
1089
-- note that OUT parameters for the returned fields are *not* needed
1090
CREATE OR REPLACE FUNCTION [schema].keys(value [schema].[base_type])
1091
  RETURNS record AS
1092
$BODY$
1093
SELECT ($1.key_field_0, $1.key_field_1)
1094
$BODY$
1095
  LANGUAGE sql IMMUTABLE
1096
  COST 100;
1097

    
1098

    
1099
to run EXPLAIN on the FULL JOIN query:
1100
# run this function
1101
# look for a NOTICE containing the expanded query that it ran
1102
# run EXPLAIN on this expanded query
1103
';
1104

    
1105

    
1106
--
1107
-- Name: do_optionally_ignore(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1108
--
1109

    
1110
CREATE FUNCTION do_optionally_ignore(sql text, ignore boolean) RETURNS void
1111
    LANGUAGE sql
1112
    AS $_$
1113
SELECT CASE WHEN $2 THEN util.try_create($1) ELSE util.create_if_not_exists($1) END
1114
$_$;
1115

    
1116

    
1117
--
1118
-- Name: FUNCTION do_optionally_ignore(sql text, ignore boolean); Type: COMMENT; Schema: util; Owner: -
1119
--
1120

    
1121
COMMENT ON FUNCTION do_optionally_ignore(sql text, ignore boolean) IS '
1122
idempotent
1123
';
1124

    
1125

    
1126
--
1127
-- Name: drop_column(col_ref, boolean); Type: FUNCTION; Schema: util; Owner: -
1128
--
1129

    
1130
CREATE FUNCTION drop_column(col col_ref, force boolean DEFAULT false) RETURNS void
1131
    LANGUAGE sql
1132
    AS $_$
1133
SELECT util.eval($$ALTER TABLE $$||$1.table_||$$ DROP COLUMN IF EXISTS $$||
1134
quote_ident($1.name)||util._if($2, $$ CASCADE$$, ''::text))
1135
$_$;
1136

    
1137

    
1138
--
1139
-- Name: FUNCTION drop_column(col col_ref, force boolean); Type: COMMENT; Schema: util; Owner: -
1140
--
1141

    
1142
COMMENT ON FUNCTION drop_column(col col_ref, force boolean) IS '
1143
idempotent
1144
';
1145

    
1146

    
1147
--
1148
-- Name: drop_relation(regclass, boolean); Type: FUNCTION; Schema: util; Owner: -
1149
--
1150

    
1151
CREATE FUNCTION drop_relation(relation regclass, force boolean DEFAULT false) RETURNS void
1152
    LANGUAGE sql
1153
    AS $_$
1154
/* use util.qual_name() instead of ::text so that the schema qualifier is always
1155
included in the debug SQL */
1156
SELECT util.drop_relation(util.relation_type($1), util.qual_name($1), $2)
1157
$_$;
1158

    
1159

    
1160
--
1161
-- Name: drop_relation(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1162
--
1163

    
1164
CREATE FUNCTION drop_relation(type text, relation_esc text, force boolean DEFAULT false) RETURNS void
1165
    LANGUAGE sql
1166
    AS $_$
1167
SELECT util.eval($$DROP $$||$1||$$ IF EXISTS $$||$2
1168
||util._if($3, $$ CASCADE$$, ''::text))
1169
$_$;
1170

    
1171

    
1172
--
1173
-- Name: FUNCTION drop_relation(type text, relation_esc text, force boolean); Type: COMMENT; Schema: util; Owner: -
1174
--
1175

    
1176
COMMENT ON FUNCTION drop_relation(type text, relation_esc text, force boolean) IS '
1177
idempotent
1178
';
1179

    
1180

    
1181
--
1182
-- Name: drop_relations_like(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1183
--
1184

    
1185
CREATE FUNCTION drop_relations_like(name_regexp text, schema_anchor anyelement, force boolean DEFAULT false) RETURNS void
1186
    LANGUAGE sql
1187
    AS $_$
1188
SELECT util.drop_relations_like($1, util.schema_regexp($2), $3)
1189
$_$;
1190

    
1191

    
1192
--
1193
-- Name: drop_relations_like(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1194
--
1195

    
1196
CREATE FUNCTION drop_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, force boolean DEFAULT false) RETURNS void
1197
    LANGUAGE sql
1198
    AS $_$
1199
SELECT util.drop_relation(relation, $3)
1200
FROM util.show_relations_like($1, $2) relation
1201
;
1202
SELECT NULL::void; -- don't fold away functions called in previous query
1203
$_$;
1204

    
1205

    
1206
--
1207
-- Name: drop_table(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1208
--
1209

    
1210
CREATE FUNCTION drop_table(table_ text, force boolean DEFAULT false) RETURNS void
1211
    LANGUAGE sql
1212
    AS $_$
1213
SELECT util.drop_relation('TABLE', $1, $2)
1214
$_$;
1215

    
1216

    
1217
--
1218
-- Name: FUNCTION drop_table(table_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1219
--
1220

    
1221
COMMENT ON FUNCTION drop_table(table_ text, force boolean) IS '
1222
idempotent
1223
';
1224

    
1225

    
1226
--
1227
-- Name: drop_view(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1228
--
1229

    
1230
CREATE FUNCTION drop_view(view_ text, force boolean DEFAULT false) RETURNS void
1231
    LANGUAGE sql
1232
    AS $_$
1233
SELECT util.drop_relation('VIEW', $1, $2)
1234
$_$;
1235

    
1236

    
1237
--
1238
-- Name: FUNCTION drop_view(view_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1239
--
1240

    
1241
COMMENT ON FUNCTION drop_view(view_ text, force boolean) IS '
1242
idempotent
1243
';
1244

    
1245

    
1246
--
1247
-- Name: empty_array(anyelement); Type: FUNCTION; Schema: util; Owner: -
1248
--
1249

    
1250
CREATE FUNCTION empty_array(elem_type_null anyelement DEFAULT NULL::text) RETURNS anyarray
1251
    LANGUAGE sql IMMUTABLE
1252
    AS $_$
1253
SELECT util.array_fill($1, 0)
1254
$_$;
1255

    
1256

    
1257
--
1258
-- Name: FUNCTION empty_array(elem_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1259
--
1260

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

    
1265

    
1266
--
1267
-- Name: ensure_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1268
--
1269

    
1270
CREATE FUNCTION ensure_prefix(prefix text, str text) RETURNS text
1271
    LANGUAGE sql IMMUTABLE
1272
    AS $_$
1273
SELECT (CASE WHEN util.has_prefix($1, $2) THEN $2 ELSE $1||$2 END)
1274
$_$;
1275

    
1276

    
1277
--
1278
-- Name: esc_name__append(text, text); Type: FUNCTION; Schema: util; Owner: -
1279
--
1280

    
1281
CREATE FUNCTION esc_name__append(suffix text, esc_name text) RETURNS text
1282
    LANGUAGE sql IMMUTABLE
1283
    AS $_$
1284
SELECT regexp_replace($2, '("?)$', $1||'\1')
1285
$_$;
1286

    
1287

    
1288
--
1289
-- Name: eval(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1290
--
1291

    
1292
CREATE FUNCTION eval(sql text, verbose_ boolean DEFAULT true) RETURNS void
1293
    LANGUAGE plpgsql STRICT
1294
    AS $$
1295
BEGIN
1296
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1297
	EXECUTE sql;
1298
END;
1299
$$;
1300

    
1301

    
1302
--
1303
-- Name: eval2col_pair(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1304
--
1305

    
1306
CREATE FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1307
    LANGUAGE plpgsql
1308
    AS $$
1309
BEGIN
1310
	PERFORM util.debug_print_sql(sql);
1311
	RETURN QUERY EXECUTE sql;
1312
END;
1313
$$;
1314

    
1315

    
1316
--
1317
-- Name: FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1318
--
1319

    
1320
COMMENT ON FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1321
col_type_null (*required*): NULL::col_type
1322
';
1323

    
1324

    
1325
--
1326
-- Name: eval2records(text); Type: FUNCTION; Schema: util; Owner: -
1327
--
1328

    
1329
CREATE FUNCTION eval2records(sql text) RETURNS SETOF record
1330
    LANGUAGE plpgsql
1331
    AS $$
1332
BEGIN
1333
	PERFORM util.debug_print_sql(sql);
1334
	RETURN QUERY EXECUTE sql;
1335
END;
1336
$$;
1337

    
1338

    
1339
--
1340
-- Name: eval2set(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1341
--
1342

    
1343
CREATE FUNCTION eval2set(sql text, ret_type_null anyelement DEFAULT NULL::text, verbose_ boolean DEFAULT true) RETURNS SETOF anyelement
1344
    LANGUAGE plpgsql
1345
    AS $$
1346
BEGIN
1347
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1348
	RETURN QUERY EXECUTE sql;
1349
END;
1350
$$;
1351

    
1352

    
1353
--
1354
-- Name: eval2val(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1355
--
1356

    
1357
CREATE FUNCTION eval2val(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1358
    LANGUAGE plpgsql STABLE
1359
    AS $$
1360
DECLARE
1361
	ret_val ret_type_null%TYPE;
1362
BEGIN
1363
	PERFORM util.debug_print_sql(sql);
1364
	EXECUTE sql INTO STRICT ret_val;
1365
	RETURN ret_val;
1366
END;
1367
$$;
1368

    
1369

    
1370
--
1371
-- Name: FUNCTION eval2val(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1372
--
1373

    
1374
COMMENT ON FUNCTION eval2val(sql text, ret_type_null anyelement) IS '
1375
ret_type_null: NULL::ret_type
1376
';
1377

    
1378

    
1379
--
1380
-- Name: eval_expr(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1381
--
1382

    
1383
CREATE FUNCTION eval_expr(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1384
    LANGUAGE sql
1385
    AS $_$
1386
SELECT util.eval2val($$SELECT $$||$1, $2)
1387
$_$;
1388

    
1389

    
1390
--
1391
-- Name: FUNCTION eval_expr(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1392
--
1393

    
1394
COMMENT ON FUNCTION eval_expr(sql text, ret_type_null anyelement) IS '
1395
ret_type_null: NULL::ret_type
1396
';
1397

    
1398

    
1399
--
1400
-- Name: eval_expr_passthru(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1401
--
1402

    
1403
CREATE FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1404
    LANGUAGE sql
1405
    AS $_$
1406
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE util.eval_expr($1, $2) END
1407
$_$;
1408

    
1409

    
1410
--
1411
-- Name: FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1412
--
1413

    
1414
COMMENT ON FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement) IS '
1415
sql: can be NULL, which will be passed through
1416
ret_type_null: NULL::ret_type
1417
';
1418

    
1419

    
1420
--
1421
-- Name: existing_cols(regclass, text[]); Type: FUNCTION; Schema: util; Owner: -
1422
--
1423

    
1424
CREATE FUNCTION existing_cols(table_ regclass, VARIADIC col_names text[]) RETURNS SETOF text
1425
    LANGUAGE sql STABLE
1426
    AS $_$
1427
SELECT col_name
1428
FROM unnest($2) s (col_name)
1429
WHERE util.col_exists(($1, col_name))
1430
$_$;
1431

    
1432

    
1433
--
1434
-- Name: explain(text); Type: FUNCTION; Schema: util; Owner: -
1435
--
1436

    
1437
CREATE FUNCTION explain(sql text) RETURNS SETOF text
1438
    LANGUAGE sql
1439
    AS $_$
1440
SELECT util.eval2set($$EXPLAIN $$||$1, verbose_ := false)
1441
$_$;
1442

    
1443

    
1444
--
1445
-- Name: explain2notice(text); Type: FUNCTION; Schema: util; Owner: -
1446
--
1447

    
1448
CREATE FUNCTION explain2notice(sql text) RETURNS void
1449
    LANGUAGE sql
1450
    AS $_$
1451
SELECT util.raise('NOTICE', util.explain2notice_msg($1))
1452
$_$;
1453

    
1454

    
1455
--
1456
-- Name: explain2notice_msg(text); Type: FUNCTION; Schema: util; Owner: -
1457
--
1458

    
1459
CREATE FUNCTION explain2notice_msg(sql text) RETURNS text
1460
    LANGUAGE sql
1461
    AS $_$
1462
-- newline before and after to visually separate it from other debug info
1463
SELECT $$
1464
EXPLAIN:
1465
$$||util.explain2str($1)||$$
1466
$$
1467
$_$;
1468

    
1469

    
1470
--
1471
-- Name: explain2notice_msg_if_can(text); Type: FUNCTION; Schema: util; Owner: -
1472
--
1473

    
1474
CREATE FUNCTION explain2notice_msg_if_can(sql text) RETURNS text
1475
    LANGUAGE sql
1476
    AS $_$
1477
SELECT (CASE WHEN util.is_explainable($1) THEN util.explain2notice_msg($1) END)
1478
$_$;
1479

    
1480

    
1481
--
1482
-- Name: explain2str(text); Type: FUNCTION; Schema: util; Owner: -
1483
--
1484

    
1485
CREATE FUNCTION explain2str(sql text) RETURNS text
1486
    LANGUAGE sql
1487
    AS $_$
1488
SELECT util.join_strs(explain, $$
1489
$$) FROM util.explain($1)
1490
$_$;
1491

    
1492

    
1493
SET default_tablespace = '';
1494

    
1495
SET default_with_oids = false;
1496

    
1497
--
1498
-- Name: explain; Type: TABLE; Schema: util; Owner: -; Tablespace: 
1499
--
1500

    
1501
CREATE TABLE explain (
1502
    line text NOT NULL
1503
);
1504

    
1505

    
1506
--
1507
-- Name: explain2table(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1508
--
1509

    
1510
CREATE FUNCTION explain2table(sql text, table_ regclass DEFAULT 'explain'::regclass) RETURNS void
1511
    LANGUAGE sql
1512
    AS $_$
1513
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT util.explain(
1514
$$||quote_nullable($1)||$$
1515
)$$)
1516
$_$;
1517

    
1518

    
1519
--
1520
-- Name: FUNCTION explain2table(sql text, table_ regclass); Type: COMMENT; Schema: util; Owner: -
1521
--
1522

    
1523
COMMENT ON FUNCTION explain2table(sql text, table_ regclass) IS '
1524
usage:
1525
PERFORM util.explain2table($$
1526
query
1527
$$);
1528
';
1529

    
1530

    
1531
--
1532
-- Name: first_word(text); Type: FUNCTION; Schema: util; Owner: -
1533
--
1534

    
1535
CREATE FUNCTION first_word(str text) RETURNS text
1536
    LANGUAGE sql IMMUTABLE
1537
    AS $_$
1538
SELECT match[1] FROM regexp_matches(util.ltrim_nl($1), '^(\S*)') match
1539
$_$;
1540

    
1541

    
1542
--
1543
-- Name: fix_array(anyarray); Type: FUNCTION; Schema: util; Owner: -
1544
--
1545

    
1546
CREATE FUNCTION fix_array("array" anyarray) RETURNS anyarray
1547
    LANGUAGE sql IMMUTABLE
1548
    AS $_$
1549
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE (
1550
	CASE WHEN pg_catalog.array_ndims($1) IS NULL THEN util.empty_array($1[1]) ELSE $1 END
1551
) END
1552
$_$;
1553

    
1554

    
1555
--
1556
-- Name: FUNCTION fix_array("array" anyarray); Type: COMMENT; Schema: util; Owner: -
1557
--
1558

    
1559
COMMENT ON FUNCTION fix_array("array" anyarray) IS '
1560
ensures that an array will always have proper non-NULL dimensions
1561
';
1562

    
1563

    
1564
--
1565
-- Name: force_recreate(text, text[]); Type: FUNCTION; Schema: util; Owner: -
1566
--
1567

    
1568
CREATE FUNCTION force_recreate(cmd text, users text[] DEFAULT NULL::text[]) RETURNS void
1569
    LANGUAGE plpgsql
1570
    AS $_$
1571
DECLARE
1572
	PG_EXCEPTION_DETAIL text;
1573
	recreate_users_cmd text = util.save_drop_views(users);
1574
BEGIN
1575
	PERFORM util.eval(cmd);
1576
	PERFORM util.eval(recreate_users_cmd);
1577
EXCEPTION
1578
WHEN dependent_objects_still_exist THEN
1579
	IF users IS NOT NULL THEN RAISE; END IF; -- save_drop_views() didn't fix it
1580
	GET STACKED DIAGNOSTICS PG_EXCEPTION_DETAIL = PG_EXCEPTION_DETAIL;
1581
	users = array(SELECT * FROM util.regexp_matches_group(
1582
		PG_EXCEPTION_DETAIL, '(?m)^view (.*) depends on table .*$'));
1583
	IF util.is_empty(users) THEN RAISE; END IF;
1584
	PERFORM util.force_recreate(cmd, users);
1585
END;
1586
$_$;
1587

    
1588

    
1589
--
1590
-- Name: FUNCTION force_recreate(cmd text, users text[]); Type: COMMENT; Schema: util; Owner: -
1591
--
1592

    
1593
COMMENT ON FUNCTION force_recreate(cmd text, users text[]) IS '
1594
idempotent
1595

    
1596
users: not necessary to provide this because it will be autopopulated
1597
';
1598

    
1599

    
1600
--
1601
-- Name: force_update_view(text, text); Type: FUNCTION; Schema: util; Owner: -
1602
--
1603

    
1604
CREATE FUNCTION force_update_view(view_ text, query text) RETURNS void
1605
    LANGUAGE plpgsql STRICT
1606
    AS $_$
1607
DECLARE
1608
	mk_view text = $$CREATE OR REPLACE VIEW $$||view_||$$ AS
1609
$$||query;
1610
BEGIN
1611
	EXECUTE mk_view;
1612
EXCEPTION
1613
WHEN invalid_table_definition THEN
1614
	IF SQLERRM = 'cannot drop columns from view'
1615
	OR SQLERRM LIKE 'cannot change name of view column "%" to "%"'
1616
	THEN
1617
		EXECUTE $$DROP VIEW $$||view_||$$ CASCADE$$;
1618
		EXECUTE mk_view;
1619
	ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM;
1620
	END IF;
1621
END;
1622
$_$;
1623

    
1624

    
1625
--
1626
-- Name: FUNCTION force_update_view(view_ text, query text); Type: COMMENT; Schema: util; Owner: -
1627
--
1628

    
1629
COMMENT ON FUNCTION force_update_view(view_ text, query text) IS '
1630
idempotent
1631
';
1632

    
1633

    
1634
--
1635
-- Name: grants_users(); Type: FUNCTION; Schema: util; Owner: -
1636
--
1637

    
1638
CREATE FUNCTION grants_users() RETURNS SETOF text
1639
    LANGUAGE sql IMMUTABLE
1640
    AS $$
1641
VALUES ('bien_read'), ('public_')
1642
$$;
1643

    
1644

    
1645
--
1646
-- Name: has_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1647
--
1648

    
1649
CREATE FUNCTION has_prefix(prefix text, str text) RETURNS boolean
1650
    LANGUAGE sql IMMUTABLE
1651
    AS $_$
1652
SELECT substring($2 for length($1)) = $1
1653
$_$;
1654

    
1655

    
1656
--
1657
-- Name: has_single_row(regclass); Type: FUNCTION; Schema: util; Owner: -
1658
--
1659

    
1660
CREATE FUNCTION has_single_row(table_ regclass) RETURNS boolean
1661
    LANGUAGE sql STABLE
1662
    AS $_$
1663
SELECT util.eval2val($$SELECT COUNT(*) = 1 FROM $$||$1, NULL::boolean)
1664
$_$;
1665

    
1666

    
1667
--
1668
-- Name: hstore(text[], text); Type: FUNCTION; Schema: util; Owner: -
1669
--
1670

    
1671
CREATE FUNCTION hstore(keys text[], value text) RETURNS hstore
1672
    LANGUAGE sql IMMUTABLE
1673
    AS $_$
1674
SELECT hstore(util.fix_array($1), util.array_fill($2, util.array_length($1)))
1675
$_$;
1676

    
1677

    
1678
--
1679
-- Name: FUNCTION hstore(keys text[], value text); Type: COMMENT; Schema: util; Owner: -
1680
--
1681

    
1682
COMMENT ON FUNCTION hstore(keys text[], value text) IS '
1683
avoids repeating the same value for each key
1684
';
1685

    
1686

    
1687
--
1688
-- Name: ifnull(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1689
--
1690

    
1691
CREATE FUNCTION ifnull(value anyelement, null_ anyelement) RETURNS anyelement
1692
    LANGUAGE sql IMMUTABLE
1693
    AS $_$
1694
SELECT COALESCE($1, $2)
1695
$_$;
1696

    
1697

    
1698
--
1699
-- Name: FUNCTION ifnull(value anyelement, null_ anyelement); Type: COMMENT; Schema: util; Owner: -
1700
--
1701

    
1702
COMMENT ON FUNCTION ifnull(value anyelement, null_ anyelement) IS '
1703
equivalent to MySQL''s IFNULL() (Postgres auto-lowercases the name)
1704
';
1705

    
1706

    
1707
--
1708
-- Name: inherit(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1709
--
1710

    
1711
CREATE FUNCTION inherit(derived regclass, base regclass) RETURNS void
1712
    LANGUAGE sql
1713
    AS $_$
1714
SELECT util.eval($$ALTER TABLE $$||$1||$$ INHERIT $$||$2)
1715
$_$;
1716

    
1717

    
1718
--
1719
-- Name: is_constant(col_ref); Type: FUNCTION; Schema: util; Owner: -
1720
--
1721

    
1722
CREATE FUNCTION is_constant(col col_ref) RETURNS boolean
1723
    LANGUAGE sql STABLE
1724
    AS $_$
1725
SELECT COALESCE(util.col_comment($1) LIKE 'constant%', false)
1726
$_$;
1727

    
1728

    
1729
--
1730
-- Name: is_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
1731
--
1732

    
1733
CREATE FUNCTION is_empty("array" anyarray) RETURNS boolean
1734
    LANGUAGE sql IMMUTABLE
1735
    AS $_$
1736
SELECT util.array_length($1) = 0
1737
$_$;
1738

    
1739

    
1740
--
1741
-- Name: is_explain(text); Type: FUNCTION; Schema: util; Owner: -
1742
--
1743

    
1744
CREATE FUNCTION is_explain(sql text) RETURNS boolean
1745
    LANGUAGE sql IMMUTABLE
1746
    AS $_$
1747
SELECT upper(util.first_word($1)) = 'EXPLAIN'
1748
$_$;
1749

    
1750

    
1751
--
1752
-- Name: is_explainable(text); Type: FUNCTION; Schema: util; Owner: -
1753
--
1754

    
1755
CREATE FUNCTION is_explainable(sql text) RETURNS boolean
1756
    LANGUAGE sql IMMUTABLE
1757
    AS $_$
1758
SELECT upper(util.first_word($1)) = ANY(
1759
'{SELECT,INSERT,UPDATE,DELETE,VALUES,EXECUTE,DECLARE}'::text[]
1760
/*from http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691*/
1761
)
1762
$_$;
1763

    
1764

    
1765
--
1766
-- Name: is_more_complete_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1767
--
1768

    
1769
CREATE FUNCTION is_more_complete_than("left" anyelement, "right" anyelement) RETURNS boolean
1770
    LANGUAGE sql IMMUTABLE
1771
    AS $_$
1772
SELECT $1 IS NOT DISTINCT FROM $2 OR ($1 IS NOT NULL AND $2 IS NULL)
1773
$_$;
1774

    
1775

    
1776
--
1777
-- Name: is_populated_more_often_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1778
--
1779

    
1780
CREATE FUNCTION is_populated_more_often_than("left" anyelement, "right" anyelement) RETURNS boolean
1781
    LANGUAGE sql IMMUTABLE
1782
    AS $_$
1783
SELECT $1 IS NOT NULL >= $2 IS NOT NULL -- true > false
1784
$_$;
1785

    
1786

    
1787
--
1788
-- Name: is_set_stmt(text); Type: FUNCTION; Schema: util; Owner: -
1789
--
1790

    
1791
CREATE FUNCTION is_set_stmt(sql text) RETURNS boolean
1792
    LANGUAGE sql IMMUTABLE
1793
    AS $_$
1794
SELECT upper(util.first_word($1)) = 'SET'
1795
$_$;
1796

    
1797

    
1798
--
1799
-- Name: is_table(regclass); Type: FUNCTION; Schema: util; Owner: -
1800
--
1801

    
1802
CREATE FUNCTION is_table(relation regclass) RETURNS boolean
1803
    LANGUAGE sql STABLE
1804
    AS $_$
1805
SELECT relkind = 'r' FROM pg_class WHERE oid = $1
1806
$_$;
1807

    
1808

    
1809
--
1810
-- Name: is_view(regclass); Type: FUNCTION; Schema: util; Owner: -
1811
--
1812

    
1813
CREATE FUNCTION is_view(relation regclass) RETURNS boolean
1814
    LANGUAGE sql STABLE
1815
    AS $_$
1816
SELECT relkind = 'v' FROM pg_class WHERE oid = $1
1817
$_$;
1818

    
1819

    
1820
--
1821
-- Name: join_strs_transform(text, text, text); Type: FUNCTION; Schema: util; Owner: -
1822
--
1823

    
1824
CREATE FUNCTION join_strs_transform(state text, value text, delim text) RETURNS text
1825
    LANGUAGE sql IMMUTABLE STRICT
1826
    AS $_$
1827
SELECT $1 || $3 || $2
1828
$_$;
1829

    
1830

    
1831
--
1832
-- Name: FUNCTION join_strs_transform(state text, value text, delim text); Type: COMMENT; Schema: util; Owner: -
1833
--
1834

    
1835
COMMENT ON FUNCTION join_strs_transform(state text, value text, delim text) IS '
1836
must be declared STRICT to use the special handling of STRICT aggregating functions
1837
';
1838

    
1839

    
1840
--
1841
-- Name: keys(anyelement); Type: FUNCTION; Schema: util; Owner: -
1842
--
1843

    
1844
CREATE FUNCTION keys(value anyelement) RETURNS anyelement
1845
    LANGUAGE sql IMMUTABLE
1846
    AS $_$
1847
SELECT $1 -- compare on the entire value
1848
$_$;
1849

    
1850

    
1851
--
1852
-- Name: limit2row_num(integer, integer, integer); Type: FUNCTION; Schema: util; Owner: -
1853
--
1854

    
1855
CREATE FUNCTION limit2row_num(limit_ integer, offset_ integer DEFAULT NULL::integer, min_row_num integer DEFAULT 1) RETURNS integer
1856
    LANGUAGE sql IMMUTABLE
1857
    AS $_$
1858
SELECT COALESCE(util.offset2row_num($2, $3) + $1 - 1, 2147483647)
1859
$_$;
1860

    
1861

    
1862
--
1863
-- Name: ltrim_nl(text); Type: FUNCTION; Schema: util; Owner: -
1864
--
1865

    
1866
CREATE FUNCTION ltrim_nl(str text) RETURNS text
1867
    LANGUAGE sql IMMUTABLE
1868
    AS $_$
1869
SELECT ltrim($1, $$
1870
$$)
1871
$_$;
1872

    
1873

    
1874
--
1875
-- Name: map_filter_insert(); Type: FUNCTION; Schema: util; Owner: -
1876
--
1877

    
1878
CREATE FUNCTION map_filter_insert() RETURNS trigger
1879
    LANGUAGE plpgsql
1880
    AS $$
1881
BEGIN
1882
	IF new."from" LIKE ':%' THEN RETURN NULL; END IF; -- exclude metadata values
1883
	RETURN new;
1884
END;
1885
$$;
1886

    
1887

    
1888
--
1889
-- Name: map_get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1890
--
1891

    
1892
CREATE FUNCTION map_get(map regclass, key text) RETURNS text
1893
    LANGUAGE plpgsql STABLE STRICT
1894
    AS $_$
1895
DECLARE
1896
    value text;
1897
BEGIN
1898
    EXECUTE $$SELECT "to" FROM $$||map||$$ WHERE "from" = $1$$
1899
        INTO value USING key;
1900
    RETURN value;
1901
END;
1902
$_$;
1903

    
1904

    
1905
--
1906
-- Name: map_nulls(text[], anyelement); Type: FUNCTION; Schema: util; Owner: -
1907
--
1908

    
1909
CREATE FUNCTION map_nulls(nulls text[], value anyelement) RETURNS anyelement
1910
    LANGUAGE sql IMMUTABLE
1911
    AS $_$
1912
SELECT util._map(util.nulls_map($1), $2)
1913
$_$;
1914

    
1915

    
1916
--
1917
-- Name: FUNCTION map_nulls(nulls text[], value anyelement); Type: COMMENT; Schema: util; Owner: -
1918
--
1919

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

    
1923
[1] inlining of function calls, which is different from constant folding
1924
[2] _map()''s profiling query
1925
SELECT util._map(''"1"=>NULL, "2"=>NULL, "3"=>NULL, *=>*'', v) FROM unnest(array_fill(1, array[100000])) f (v)
1926
and map_nulls()''s profiling query
1927
SELECT util.map_nulls(array[1, 2, 3]::text[], v) FROM unnest(array_fill(1, array[100000])) f (v)
1928
both take ~920 ms.
1929
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.
1930
';
1931

    
1932

    
1933
--
1934
-- Name: map_values(regclass); Type: FUNCTION; Schema: util; Owner: -
1935
--
1936

    
1937
CREATE FUNCTION map_values(map regclass) RETURNS SETOF text
1938
    LANGUAGE plpgsql STABLE STRICT
1939
    AS $_$
1940
BEGIN
1941
    RETURN QUERY EXECUTE $$SELECT "to" FROM $$||map;
1942
END;
1943
$_$;
1944

    
1945

    
1946
--
1947
-- Name: materialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
1948
--
1949

    
1950
CREATE FUNCTION materialize_query(table_esc text, sql text) RETURNS void
1951
    LANGUAGE sql
1952
    AS $_$
1953
SELECT util.create_if_not_exists($$CREATE TABLE $$||$1||$$ AS
1954
$$||util.ltrim_nl($2));
1955
-- make sure the created table has the correct estimated row count
1956
SELECT util.analyze_($1);
1957

    
1958
SELECT util.append_comment($1, '
1959
contents generated from:
1960
'||util.ltrim_nl($2)||';
1961
');
1962
$_$;
1963

    
1964

    
1965
--
1966
-- Name: FUNCTION materialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
1967
--
1968

    
1969
COMMENT ON FUNCTION materialize_query(table_esc text, sql text) IS '
1970
idempotent
1971
';
1972

    
1973

    
1974
--
1975
-- Name: materialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1976
--
1977

    
1978
CREATE FUNCTION materialize_view(table_esc text, view_ regclass) RETURNS void
1979
    LANGUAGE sql
1980
    AS $_$
1981
SELECT util.materialize_query($1, $$SELECT * FROM $$||$2)
1982
$_$;
1983

    
1984

    
1985
--
1986
-- Name: FUNCTION materialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
1987
--
1988

    
1989
COMMENT ON FUNCTION materialize_view(table_esc text, view_ regclass) IS '
1990
idempotent
1991
';
1992

    
1993

    
1994
--
1995
-- Name: mk_const_col(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
1996
--
1997

    
1998
CREATE FUNCTION mk_const_col(col col_ref, value anyelement) RETURNS void
1999
    LANGUAGE sql
2000
    AS $_$
2001
SELECT util.create_if_not_exists($$
2002
ALTER TABLE $$||$1.table_||$$ ADD COLUMN $$
2003
||quote_ident($1.name)||$$ $$||pg_typeof($2)||util.type_qual($2)||$$ DEFAULT $$
2004
||quote_literal($2)||$$;
2005
COMMENT ON COLUMN $$||$1.table_||$$.$$||quote_ident($1.name)||$$ IS '
2006
constant
2007
';
2008
$$)
2009
$_$;
2010

    
2011

    
2012
--
2013
-- Name: FUNCTION mk_const_col(col col_ref, value anyelement); Type: COMMENT; Schema: util; Owner: -
2014
--
2015

    
2016
COMMENT ON FUNCTION mk_const_col(col col_ref, value anyelement) IS '
2017
idempotent
2018
';
2019

    
2020

    
2021
--
2022
-- Name: mk_derived_col(col_ref, text, boolean); Type: FUNCTION; Schema: util; Owner: -
2023
--
2024

    
2025
CREATE FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean DEFAULT false) RETURNS void
2026
    LANGUAGE plpgsql STRICT
2027
    AS $_$
2028
DECLARE
2029
    type regtype = util.typeof(expr, col.table_::text::regtype);
2030
    col_name_sql text = quote_ident(col.name);
2031
BEGIN
2032
    PERFORM util.create_if_not_exists((CASE WHEN overwrite THEN '' ELSE $$
2033
ALTER TABLE $$||col.table_||$$ ADD   COLUMN $$||col_name_sql||$$      $$||type||$$;$$ END)||$$
2034
ALTER TABLE $$||col.table_||$$ ALTER COLUMN $$||col_name_sql||$$ TYPE $$||type||$$ USING
2035
$$||expr||$$;
2036
$$);
2037
END;
2038
$_$;
2039

    
2040

    
2041
--
2042
-- Name: FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean); Type: COMMENT; Schema: util; Owner: -
2043
--
2044

    
2045
COMMENT ON FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean) IS '
2046
idempotent
2047
';
2048

    
2049

    
2050
--
2051
-- Name: mk_diff_query(text, text, boolean, text, text, text); Type: FUNCTION; Schema: util; Owner: -
2052
--
2053

    
2054
CREATE FUNCTION mk_diff_query(left_ text, right_ text, single_row boolean DEFAULT false, 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
2055
    LANGUAGE sql IMMUTABLE
2056
    AS $_$
2057
SELECT
2058
$$SELECT
2059
$$||$4||$$
2060
FROM $$||$1||$$ left_
2061
$$||util._if($3, 'CROSS'::text, 'FULL')||$$ JOIN $$||$2||$$ right_
2062
$$||util._if($3, ''::text,
2063
$$ON $$||$5||$$
2064
$$)||
2065
$$WHERE $$||$6||$$
2066
ORDER BY left_, right_
2067
$$
2068
$_$;
2069

    
2070

    
2071
--
2072
-- Name: FUNCTION mk_diff_query(left_ text, right_ text, single_row boolean, cols text, join_cond text, filter text); Type: COMMENT; Schema: util; Owner: -
2073
--
2074

    
2075
COMMENT ON FUNCTION mk_diff_query(left_ text, right_ text, single_row boolean, cols text, join_cond text, filter text) IS '
2076
single_row: whether the tables consist of a single row, which should be
2077
	displayed side-by-side
2078
';
2079

    
2080

    
2081
--
2082
-- Name: mk_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2083
--
2084

    
2085
CREATE FUNCTION mk_map_table(table_ text) RETURNS void
2086
    LANGUAGE sql
2087
    AS $_$
2088
SELECT util.create_if_not_exists($$
2089
CREATE TABLE $$||$1||$$
2090
(
2091
    LIKE util.map INCLUDING ALL
2092
);
2093

    
2094
CREATE TRIGGER map_filter_insert
2095
  BEFORE INSERT
2096
  ON $$||$1||$$
2097
  FOR EACH ROW
2098
  EXECUTE PROCEDURE util.map_filter_insert();
2099
$$)
2100
$_$;
2101

    
2102

    
2103
--
2104
-- Name: mk_search_path(text[]); Type: FUNCTION; Schema: util; Owner: -
2105
--
2106

    
2107
CREATE FUNCTION mk_search_path(VARIADIC schemas text[]) RETURNS text
2108
    LANGUAGE sql IMMUTABLE
2109
    AS $_$
2110
SELECT string_agg(quote_ident(unnest), ', ') FROM unnest($1||'util'::text)
2111
$_$;
2112

    
2113

    
2114
--
2115
-- Name: FUNCTION mk_search_path(VARIADIC schemas text[]); Type: COMMENT; Schema: util; Owner: -
2116
--
2117

    
2118
COMMENT ON FUNCTION mk_search_path(VARIADIC schemas text[]) IS '
2119
auto-appends util to the search_path to enable use of util operators
2120
';
2121

    
2122

    
2123
--
2124
-- Name: mk_set_search_path(boolean); Type: FUNCTION; Schema: util; Owner: -
2125
--
2126

    
2127
CREATE FUNCTION mk_set_search_path(for_printing boolean DEFAULT false) RETURNS text
2128
    LANGUAGE sql IMMUTABLE
2129
    AS $_$
2130
SELECT util.mk_set_search_path(current_setting('search_path'), $1)
2131
$_$;
2132

    
2133

    
2134
--
2135
-- Name: mk_set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
2136
--
2137

    
2138
CREATE FUNCTION mk_set_search_path(search_path text, for_printing boolean DEFAULT false) RETURNS text
2139
    LANGUAGE sql IMMUTABLE
2140
    AS $_$
2141
/* debug_print_return_value() needed because this function is used with EXECUTE
2142
rather than util.eval() (in order to affect the calling function), so the
2143
search_path would not otherwise be printed */
2144
SELECT $$SET$$||util._if($2, $$ /*LOCAL*/$$::text, $$ LOCAL$$)
2145
||$$ search_path TO $$||$1
2146
$_$;
2147

    
2148

    
2149
--
2150
-- Name: mk_source_col(regclass); Type: FUNCTION; Schema: util; Owner: -
2151
--
2152

    
2153
CREATE FUNCTION mk_source_col(table_ regclass) RETURNS void
2154
    LANGUAGE sql
2155
    AS $_$
2156
SELECT util.mk_const_col(($1, 'source'), util.schema($1))
2157
$_$;
2158

    
2159

    
2160
--
2161
-- Name: FUNCTION mk_source_col(table_ regclass); Type: COMMENT; Schema: util; Owner: -
2162
--
2163

    
2164
COMMENT ON FUNCTION mk_source_col(table_ regclass) IS '
2165
idempotent
2166
';
2167

    
2168

    
2169
--
2170
-- Name: mk_subset_by_row_num_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2171
--
2172

    
2173
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass) RETURNS void
2174
    LANGUAGE plpgsql STRICT
2175
    AS $_$
2176
DECLARE
2177
	view_qual_name text = util.qual_name(view_);
2178
BEGIN
2179
	EXECUTE $$
2180
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2181
  RETURNS SETOF $$||view_||$$ AS
2182
$BODY1$
2183
SELECT * FROM $$||view_qual_name||$$
2184
ORDER BY sort_col
2185
LIMIT $1 OFFSET $2
2186
$BODY1$
2187
  LANGUAGE sql STABLE
2188
  COST 100
2189
  ROWS 1000
2190
$$;
2191
	
2192
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2193
END;
2194
$_$;
2195

    
2196

    
2197
--
2198
-- Name: mk_subset_by_row_num_func(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2199
--
2200

    
2201
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass, row_num_col text) RETURNS void
2202
    LANGUAGE plpgsql STRICT
2203
    AS $_$
2204
DECLARE
2205
	view_qual_name text = util.qual_name(view_);
2206
	row_num__min__fn text = util.esc_name__append('__row_num__min', view_qual_name);
2207
BEGIN
2208
	EXECUTE $$
2209
CREATE OR REPLACE FUNCTION $$||row_num__min__fn||$$()
2210
  RETURNS integer AS
2211
$BODY1$
2212
SELECT $$||quote_ident(row_num_col)||$$
2213
FROM $$||view_qual_name||$$
2214
ORDER BY $$||quote_ident(row_num_col)||$$ ASC
2215
LIMIT 1
2216
$BODY1$
2217
  LANGUAGE sql STABLE
2218
  COST 100;
2219
$$;
2220
	
2221
	EXECUTE $$
2222
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2223
  RETURNS SETOF $$||view_||$$ AS
2224
$BODY1$
2225
SELECT * FROM $$||view_qual_name||$$
2226
WHERE $$||quote_ident(row_num_col)||$$ BETWEEN
2227
	util.offset2row_num(    $2, $$||row_num__min__fn||$$())
2228
AND util.limit2row_num ($1, $2, $$||row_num__min__fn||$$())
2229
ORDER BY $$||quote_ident(row_num_col)||$$
2230
$BODY1$
2231
  LANGUAGE sql STABLE
2232
  COST 100
2233
  ROWS 1000
2234
$$;
2235
	
2236
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2237
END;
2238
$_$;
2239

    
2240

    
2241
--
2242
-- Name: mk_subset_by_row_num_no_sort_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2243
--
2244

    
2245
CREATE FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) RETURNS void
2246
    LANGUAGE plpgsql STRICT
2247
    AS $_$
2248
DECLARE
2249
	view_qual_name text = util.qual_name(view_);
2250
BEGIN
2251
	EXECUTE $$
2252
CREATE OR REPLACE FUNCTION $$||view_||$$(no_sort boolean, limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2253
  RETURNS SETOF $$||view_||$$
2254
  SET enable_sort TO 'off'
2255
  AS
2256
$BODY1$
2257
SELECT * FROM $$||view_qual_name||$$($2, $3)
2258
$BODY1$
2259
  LANGUAGE sql STABLE
2260
  COST 100
2261
  ROWS 1000
2262
;
2263
COMMENT ON FUNCTION $$||view_||$$(no_sort boolean, limit_ integer, offset_ integer) IS '
2264
Use this for limit values greater than ~100,000 to avoid unwanted slow sorts.
2265
If you want to run EXPLAIN and get expanded output, use the regular subset
2266
function instead. (When a config param is set on a function, EXPLAIN produces
2267
just a function scan.)
2268
';
2269
$$;
2270
END;
2271
$_$;
2272

    
2273

    
2274
--
2275
-- Name: FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass); Type: COMMENT; Schema: util; Owner: -
2276
--
2277

    
2278
COMMENT ON FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) IS '
2279
creates subset function which turns off enable_sort
2280
';
2281

    
2282

    
2283
--
2284
-- Name: name(regclass); Type: FUNCTION; Schema: util; Owner: -
2285
--
2286

    
2287
CREATE FUNCTION name(table_ regclass) RETURNS text
2288
    LANGUAGE sql STABLE
2289
    AS $_$
2290
SELECT relname::text FROM pg_class WHERE oid = $1
2291
$_$;
2292

    
2293

    
2294
--
2295
-- Name: name(regtype); Type: FUNCTION; Schema: util; Owner: -
2296
--
2297

    
2298
CREATE FUNCTION name(type regtype) RETURNS text
2299
    LANGUAGE sql STABLE
2300
    AS $_$
2301
SELECT typname::text FROM pg_type WHERE oid = $1
2302
$_$;
2303

    
2304

    
2305
--
2306
-- Name: name_was_truncated(text, integer); Type: FUNCTION; Schema: util; Owner: -
2307
--
2308

    
2309
CREATE FUNCTION name_was_truncated(name_ text, max_prefix_len integer DEFAULT 0) RETURNS boolean
2310
    LANGUAGE sql IMMUTABLE
2311
    AS $_$
2312
SELECT octet_length($1) >= util.namedatalen() - $2
2313
$_$;
2314

    
2315

    
2316
--
2317
-- Name: namedatalen(); Type: FUNCTION; Schema: util; Owner: -
2318
--
2319

    
2320
CREATE FUNCTION namedatalen() RETURNS integer
2321
    LANGUAGE sql IMMUTABLE
2322
    AS $$
2323
SELECT octet_length(repeat('_', 1024/*>63*/)::name::text)
2324
$$;
2325

    
2326

    
2327
--
2328
-- Name: not_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2329
--
2330

    
2331
CREATE FUNCTION not_empty(value anyarray) RETURNS boolean
2332
    LANGUAGE sql IMMUTABLE
2333
    AS $_$
2334
SELECT $1 IS NOT NULL AND util.array_length($1) > 0
2335
$_$;
2336

    
2337

    
2338
--
2339
-- Name: not_null(anyelement); Type: FUNCTION; Schema: util; Owner: -
2340
--
2341

    
2342
CREATE FUNCTION not_null(value anyelement) RETURNS boolean
2343
    LANGUAGE sql IMMUTABLE
2344
    AS $_$
2345
SELECT $1 IS NOT NULL
2346
$_$;
2347

    
2348

    
2349
--
2350
-- Name: nulls_map(text[]); Type: FUNCTION; Schema: util; Owner: -
2351
--
2352

    
2353
CREATE FUNCTION nulls_map(nulls text[]) RETURNS hstore
2354
    LANGUAGE sql IMMUTABLE
2355
    AS $_$
2356
SELECT util.hstore($1, NULL) || '*=>*'
2357
$_$;
2358

    
2359

    
2360
--
2361
-- Name: FUNCTION nulls_map(nulls text[]); Type: COMMENT; Schema: util; Owner: -
2362
--
2363

    
2364
COMMENT ON FUNCTION nulls_map(nulls text[]) IS '
2365
for use with _map()
2366
';
2367

    
2368

    
2369
--
2370
-- Name: offset2row_num(integer, integer); Type: FUNCTION; Schema: util; Owner: -
2371
--
2372

    
2373
CREATE FUNCTION offset2row_num(offset_ integer, min_row_num integer DEFAULT 1) RETURNS integer
2374
    LANGUAGE sql IMMUTABLE
2375
    AS $_$
2376
SELECT $2 + COALESCE($1, 0)
2377
$_$;
2378

    
2379

    
2380
--
2381
-- Name: prepend_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2382
--
2383

    
2384
CREATE FUNCTION prepend_comment(table_ regclass, comment text) RETURNS void
2385
    LANGUAGE sql
2386
    AS $_$
2387
SELECT util.set_comment($1, concat($2, util.comment($1)))
2388
$_$;
2389

    
2390

    
2391
--
2392
-- Name: FUNCTION prepend_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
2393
--
2394

    
2395
COMMENT ON FUNCTION prepend_comment(table_ regclass, comment text) IS '
2396
comment: must start and end with a newline
2397
';
2398

    
2399

    
2400
--
2401
-- Name: qual_name(text[]); Type: FUNCTION; Schema: util; Owner: -
2402
--
2403

    
2404
CREATE FUNCTION qual_name(VARIADIC elems text[]) RETURNS text
2405
    LANGUAGE sql IMMUTABLE
2406
    AS $_$
2407
SELECT string_agg(quote_ident(unnest), '.') FROM unnest($1)
2408
$_$;
2409

    
2410

    
2411
--
2412
-- Name: qual_name(regclass); Type: FUNCTION; Schema: util; Owner: -
2413
--
2414

    
2415
CREATE FUNCTION qual_name(table_ regclass) RETURNS text
2416
    LANGUAGE sql STABLE
2417
    SET search_path TO pg_temp
2418
    AS $_$
2419
SELECT $1::text
2420
$_$;
2421

    
2422

    
2423
--
2424
-- Name: qual_name(regtype); Type: FUNCTION; Schema: util; Owner: -
2425
--
2426

    
2427
CREATE FUNCTION qual_name(type regtype) RETURNS text
2428
    LANGUAGE sql STABLE
2429
    SET search_path TO pg_temp
2430
    AS $_$
2431
SELECT $1::text
2432
$_$;
2433

    
2434

    
2435
--
2436
-- Name: FUNCTION qual_name(type regtype); Type: COMMENT; Schema: util; Owner: -
2437
--
2438

    
2439
COMMENT ON FUNCTION qual_name(type regtype) IS '
2440
a type''s schema-qualified name
2441
';
2442

    
2443

    
2444
--
2445
-- Name: qual_name(unknown); Type: FUNCTION; Schema: util; Owner: -
2446
--
2447

    
2448
CREATE FUNCTION qual_name(type unknown) RETURNS text
2449
    LANGUAGE sql STABLE
2450
    AS $_$
2451
SELECT util.qual_name($1::text::regtype)
2452
$_$;
2453

    
2454

    
2455
--
2456
-- Name: quote_func_call(regprocedure, text[]); Type: FUNCTION; Schema: util; Owner: -
2457
--
2458

    
2459
CREATE FUNCTION quote_func_call(func regprocedure, VARIADIC args_esc text[]) RETURNS text
2460
    LANGUAGE sql IMMUTABLE
2461
    AS $_$
2462
SELECT util.quote_func_call($1::regproc::text, VARIADIC $2)
2463
$_$;
2464

    
2465

    
2466
--
2467
-- Name: quote_func_call(text, text[]); Type: FUNCTION; Schema: util; Owner: -
2468
--
2469

    
2470
CREATE FUNCTION quote_func_call(func_esc text, VARIADIC args_esc text[]) RETURNS text
2471
    LANGUAGE sql IMMUTABLE
2472
    AS $_$
2473
SELECT $1||'('||concat_ws(', ', VARIADIC $2)||')'
2474
$_$;
2475

    
2476

    
2477
--
2478
-- Name: quote_typed(anyelement); Type: FUNCTION; Schema: util; Owner: -
2479
--
2480

    
2481
CREATE FUNCTION quote_typed(value anyelement) RETURNS text
2482
    LANGUAGE sql IMMUTABLE
2483
    AS $_$
2484
SELECT quote_nullable($1)||$$::$$||util.qual_name(pg_typeof($1))
2485
$_$;
2486

    
2487

    
2488
--
2489
-- Name: raise(text, text); Type: FUNCTION; Schema: util; Owner: -
2490
--
2491

    
2492
CREATE FUNCTION raise(type text, msg text) RETURNS void
2493
    LANGUAGE sql IMMUTABLE
2494
    AS $_$
2495
SELECT util.eval($$
2496
CREATE OR REPLACE FUNCTION pg_temp.__raise()
2497
  RETURNS void AS
2498
$BODY1$
2499
BEGIN
2500
	RAISE $$||$1||$$ USING MESSAGE = $$||quote_nullable($2)||$$;
2501
END;
2502
$BODY1$
2503
  LANGUAGE plpgsql IMMUTABLE
2504
  COST 100;
2505
$$, verbose_ := false);
2506

    
2507
SELECT util.eval($$SELECT pg_temp.__raise()$$, verbose_ := false);
2508
$_$;
2509

    
2510

    
2511
--
2512
-- Name: FUNCTION raise(type text, msg text); Type: COMMENT; Schema: util; Owner: -
2513
--
2514

    
2515
COMMENT ON FUNCTION raise(type text, msg text) IS '
2516
type: a log level from
2517
http://www.postgresql.org/docs/9.3/static/plpgsql-errors-and-messages.html
2518
or a condition name from
2519
http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
2520
';
2521

    
2522

    
2523
--
2524
-- Name: raise_error_warning(text); Type: FUNCTION; Schema: util; Owner: -
2525
--
2526

    
2527
CREATE FUNCTION raise_error_warning(msg text) RETURNS void
2528
    LANGUAGE sql IMMUTABLE
2529
    AS $_$
2530
SELECT util.raise('WARNING', 'ERROR:  '||$1)
2531
$_$;
2532

    
2533

    
2534
--
2535
-- Name: raise_undefined_column(col_ref); Type: FUNCTION; Schema: util; Owner: -
2536
--
2537

    
2538
CREATE FUNCTION raise_undefined_column(col col_ref) RETURNS text
2539
    LANGUAGE plpgsql IMMUTABLE STRICT
2540
    AS $$
2541
BEGIN
2542
	RAISE undefined_column USING MESSAGE = concat('undefined column: ', col.name);
2543
END;
2544
$$;
2545

    
2546

    
2547
--
2548
-- Name: regexp_matches_group(text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2549
--
2550

    
2551
CREATE FUNCTION regexp_matches_group(str text, re text, group_ integer DEFAULT 1) RETURNS SETOF text
2552
    LANGUAGE sql IMMUTABLE
2553
    AS $_$
2554
SELECT regexp_matches[$3] FROM regexp_matches($1, $2, 'g')
2555
$_$;
2556

    
2557

    
2558
--
2559
-- Name: regexp_quote(text); Type: FUNCTION; Schema: util; Owner: -
2560
--
2561

    
2562
CREATE FUNCTION regexp_quote(str text) RETURNS text
2563
    LANGUAGE sql IMMUTABLE
2564
    AS $_$
2565
SELECT regexp_replace($1, '\W', /*\char*/'\\\&', 'g')
2566
$_$;
2567

    
2568

    
2569
--
2570
-- Name: regprocedure(text); Type: FUNCTION; Schema: util; Owner: -
2571
--
2572

    
2573
CREATE FUNCTION regprocedure(func text) RETURNS regprocedure
2574
    LANGUAGE sql IMMUTABLE
2575
    AS $_$
2576
SELECT (CASE WHEN right($1, 1) = ')'
2577
THEN $1::regprocedure ELSE $1::regproc::regprocedure END)
2578
$_$;
2579

    
2580

    
2581
--
2582
-- Name: relation_type(regclass); Type: FUNCTION; Schema: util; Owner: -
2583
--
2584

    
2585
CREATE FUNCTION relation_type(relation regclass) RETURNS text
2586
    LANGUAGE sql STABLE
2587
    AS $_$
2588
SELECT util.relation_type(util.relation_type_char($1))
2589
$_$;
2590

    
2591

    
2592
--
2593
-- Name: relation_type("char"); Type: FUNCTION; Schema: util; Owner: -
2594
--
2595

    
2596
CREATE FUNCTION relation_type(relation_type_char "char") RETURNS text
2597
    LANGUAGE sql IMMUTABLE
2598
    AS $_$
2599
SELECT 'r=>TABLE, v=>VIEW'::hstore -> $1
2600
$_$;
2601

    
2602

    
2603
--
2604
-- Name: relation_type_char(regclass); Type: FUNCTION; Schema: util; Owner: -
2605
--
2606

    
2607
CREATE FUNCTION relation_type_char(relation regclass) RETURNS "char"
2608
    LANGUAGE sql STABLE
2609
    AS $_$
2610
SELECT relkind FROM pg_class WHERE oid = $1
2611
$_$;
2612

    
2613

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

    
2618
CREATE FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) RETURNS void
2619
    LANGUAGE sql
2620
    AS $_$
2621
/* can't have in_table/out_table inherit from *each other*, because inheritance
2622
also causes the rows of the parent table to be included in the child table.
2623
instead, they need to inherit from a common, empty table. */
2624
SELECT util.create_if_not_exists($$SELECT $$||util.quote_func_call(
2625
'util.copy_struct', util.quote_typed($2), util.quote_typed($4)));
2626
SELECT util.inherit($2, $4);
2627
SELECT util.inherit($3, $4);
2628

    
2629
SELECT util.rematerialize_query($1, $$
2630
SELECT * FROM util.diff(
2631
  $$||util.quote_typed($2)||$$
2632
, $$||util.quote_typed($3)||$$
2633
, NULL::$$||$4||$$)
2634
$$);
2635

    
2636
/* the table unfortunately cannot be *materialized* in human-readable form,
2637
because this would create column name collisions between the two sides */
2638
SELECT util.prepend_comment($1, '
2639
to view this table in human-readable form (with each side''s tuple column
2640
expanded to its component fields):
2641
SELECT (left_).*, (right_).* FROM '||$1||';
2642
');
2643
$_$;
2644

    
2645

    
2646
--
2647
-- Name: FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text); Type: COMMENT; Schema: util; Owner: -
2648
--
2649

    
2650
COMMENT ON FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) IS '
2651
type_table (*required*): table to create as the shared base type
2652
';
2653

    
2654

    
2655
--
2656
-- Name: rematerialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2657
--
2658

    
2659
CREATE FUNCTION rematerialize_query(table_esc text, sql text) RETURNS void
2660
    LANGUAGE sql
2661
    AS $_$
2662
SELECT util.drop_table($1);
2663
SELECT util.materialize_query($1, $2);
2664
$_$;
2665

    
2666

    
2667
--
2668
-- Name: FUNCTION rematerialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2669
--
2670

    
2671
COMMENT ON FUNCTION rematerialize_query(table_esc text, sql text) IS '
2672
idempotent, but repeats action each time
2673
';
2674

    
2675

    
2676
--
2677
-- Name: rematerialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2678
--
2679

    
2680
CREATE FUNCTION rematerialize_view(table_esc text, view_ regclass) RETURNS void
2681
    LANGUAGE sql
2682
    AS $_$
2683
SELECT util.drop_table($1);
2684
SELECT util.materialize_view($1, $2);
2685
$_$;
2686

    
2687

    
2688
--
2689
-- Name: FUNCTION rematerialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2690
--
2691

    
2692
COMMENT ON FUNCTION rematerialize_view(table_esc text, view_ regclass) IS '
2693
idempotent, but repeats action each time
2694
';
2695

    
2696

    
2697
--
2698
-- Name: rename_cols(regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
2699
--
2700

    
2701
CREATE FUNCTION rename_cols(table_ regclass, renames anyelement) RETURNS void
2702
    LANGUAGE sql
2703
    AS $_$
2704
SELECT util.try_create($$ALTER TABLE $$||$1||$$ RENAME $$
2705
||quote_ident(name)||$$ TO $$||quote_ident($2 -> name))
2706
FROM util.col_names($1::text::regtype) f (name);
2707
SELECT NULL::void; -- don't fold away functions called in previous query
2708
$_$;
2709

    
2710

    
2711
--
2712
-- Name: FUNCTION rename_cols(table_ regclass, renames anyelement); Type: COMMENT; Schema: util; Owner: -
2713
--
2714

    
2715
COMMENT ON FUNCTION rename_cols(table_ regclass, renames anyelement) IS '
2716
idempotent
2717
';
2718

    
2719

    
2720
--
2721
-- Name: rename_relation(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2722
--
2723

    
2724
CREATE FUNCTION rename_relation(from_ regclass, to_ text) RETURNS void
2725
    LANGUAGE sql
2726
    AS $_$
2727
/* use util.qual_name() instead of ::text so that the schema qualifier is always
2728
included in the debug SQL */
2729
SELECT util.rename_relation(util.qual_name($1), $2)
2730
$_$;
2731

    
2732

    
2733
--
2734
-- Name: rename_relation(text, text); Type: FUNCTION; Schema: util; Owner: -
2735
--
2736

    
2737
CREATE FUNCTION rename_relation(from_esc text, to_name text) RETURNS void
2738
    LANGUAGE sql
2739
    AS $_$
2740
/* 'ALTER TABLE can be used with views too'
2741
(http://www.postgresql.org/docs/9.3/static/sql-alterview.html) */
2742
SELECT util.eval($$ALTER TABLE IF EXISTS $$||$1||$$ RENAME TO $$
2743
||quote_ident($2))
2744
$_$;
2745

    
2746

    
2747
--
2748
-- Name: FUNCTION rename_relation(from_esc text, to_name text); Type: COMMENT; Schema: util; Owner: -
2749
--
2750

    
2751
COMMENT ON FUNCTION rename_relation(from_esc text, to_name text) IS '
2752
idempotent
2753
';
2754

    
2755

    
2756
--
2757
-- Name: replace_suffix(text, text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2758
--
2759

    
2760
CREATE FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer DEFAULT 0) RETURNS text
2761
    LANGUAGE sql IMMUTABLE
2762
    AS $_$
2763
SELECT regexp_replace($1, util.truncated_prefixed_name_regexp($2, $4), '\1'||$3)
2764
$_$;
2765

    
2766

    
2767
--
2768
-- Name: FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer); Type: COMMENT; Schema: util; Owner: -
2769
--
2770

    
2771
COMMENT ON FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer) IS '
2772
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 
2773
';
2774

    
2775

    
2776
--
2777
-- Name: reset_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
2778
--
2779

    
2780
CREATE FUNCTION reset_col_names(table_ regclass, names regclass) RETURNS void
2781
    LANGUAGE sql
2782
    AS $_$
2783
SELECT util.eval($$DELETE FROM $$||$2||$$ WHERE "from" LIKE ':%'$$);
2784
SELECT util.mk_derived_col(($2, 'to'), $$"from"$$, overwrite := true);
2785
SELECT util.set_col_names($1, $2);
2786
$_$;
2787

    
2788

    
2789
--
2790
-- Name: FUNCTION reset_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
2791
--
2792

    
2793
COMMENT ON FUNCTION reset_col_names(table_ regclass, names regclass) IS '
2794
idempotent.
2795
alters the names table, so it will need to be repopulated after running this function.
2796
';
2797

    
2798

    
2799
--
2800
-- Name: reset_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2801
--
2802

    
2803
CREATE FUNCTION reset_map_table(table_ text) RETURNS void
2804
    LANGUAGE sql
2805
    AS $_$
2806
SELECT util.drop_table($1);
2807
SELECT util.mk_map_table($1);
2808
$_$;
2809

    
2810

    
2811
--
2812
-- Name: rtrim_n(text, integer); Type: FUNCTION; Schema: util; Owner: -
2813
--
2814

    
2815
CREATE FUNCTION rtrim_n(str text, count integer) RETURNS text
2816
    LANGUAGE sql IMMUTABLE
2817
    AS $_$
2818
SELECT (CASE WHEN $2 <= 0 THEN $1 ELSE left($1, -$2) END)
2819
$_$;
2820

    
2821

    
2822
--
2823
-- Name: runnable_sql(text); Type: FUNCTION; Schema: util; Owner: -
2824
--
2825

    
2826
CREATE FUNCTION runnable_sql(sql text) RETURNS text
2827
    LANGUAGE sql IMMUTABLE
2828
    AS $_$
2829
SELECT (CASE WHEN util.is_set_stmt($1) THEN ''
2830
ELSE util.mk_set_search_path(for_printing := true)||$$;
2831
$$ END)||$1
2832
$_$;
2833

    
2834

    
2835
--
2836
-- Name: save_drop_view(text); Type: FUNCTION; Schema: util; Owner: -
2837
--
2838

    
2839
CREATE FUNCTION save_drop_view(view_ text) RETURNS text
2840
    LANGUAGE plpgsql STRICT
2841
    AS $_$
2842
DECLARE
2843
	result text = NULL;
2844
BEGIN
2845
	BEGIN
2846
		result = util.show_create_view(view_);
2847
		PERFORM util.eval($$DROP VIEW $$||view_);
2848
	EXCEPTION
2849
		WHEN undefined_table THEN NULL;
2850
	END;
2851
	RETURN result;
2852
END;
2853
$_$;
2854

    
2855

    
2856
--
2857
-- Name: save_drop_views(text[]); Type: FUNCTION; Schema: util; Owner: -
2858
--
2859

    
2860
CREATE FUNCTION save_drop_views(views text[]) RETURNS text
2861
    LANGUAGE sql
2862
    AS $_$
2863
SELECT string_agg(util.save_drop_view(unnest), '') FROM unnest($1)
2864
$_$;
2865

    
2866

    
2867
--
2868
-- Name: schema(oid); Type: FUNCTION; Schema: util; Owner: -
2869
--
2870

    
2871
CREATE FUNCTION schema(pg_namespace_oid oid) RETURNS text
2872
    LANGUAGE sql STABLE
2873
    AS $_$
2874
SELECT nspname::text FROM pg_namespace WHERE pg_namespace.oid = $1
2875
$_$;
2876

    
2877

    
2878
--
2879
-- Name: schema(regclass); Type: FUNCTION; Schema: util; Owner: -
2880
--
2881

    
2882
CREATE FUNCTION schema(table_ regclass) RETURNS text
2883
    LANGUAGE sql STABLE
2884
    AS $_$
2885
SELECT util.schema(relnamespace) FROM pg_class WHERE oid = $1
2886
$_$;
2887

    
2888

    
2889
--
2890
-- Name: schema(regtype); Type: FUNCTION; Schema: util; Owner: -
2891
--
2892

    
2893
CREATE FUNCTION schema(type regtype) RETURNS text
2894
    LANGUAGE sql STABLE
2895
    AS $_$
2896
SELECT util.schema(typnamespace) FROM pg_type WHERE oid = $1
2897
$_$;
2898

    
2899

    
2900
--
2901
-- Name: schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
2902
--
2903

    
2904
CREATE FUNCTION schema(type_null anyelement) RETURNS text
2905
    LANGUAGE sql STABLE
2906
    AS $_$
2907
SELECT util.schema(pg_typeof($1))
2908
$_$;
2909

    
2910

    
2911
--
2912
-- Name: schema_bundle_get_schemas(text); Type: FUNCTION; Schema: util; Owner: -
2913
--
2914

    
2915
CREATE FUNCTION schema_bundle_get_schemas(schema_bundle text) RETURNS SETOF text
2916
    LANGUAGE sql STABLE
2917
    AS $_$
2918
SELECT nspname::text FROM pg_namespace WHERE nspname ~ ('^'||$1||'(?=\y|_)')
2919
$_$;
2920

    
2921

    
2922
--
2923
-- Name: FUNCTION schema_bundle_get_schemas(schema_bundle text); Type: COMMENT; Schema: util; Owner: -
2924
--
2925

    
2926
COMMENT ON FUNCTION schema_bundle_get_schemas(schema_bundle text) IS '
2927
a schema bundle is a group of schemas with a common prefix
2928
';
2929

    
2930

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

    
2935
CREATE FUNCTION schema_bundle_rename(old text, new text) RETURNS void
2936
    LANGUAGE sql
2937
    AS $_$
2938
SELECT util.schema_rename(old_schema,
2939
	overlay(old_schema placing new from 1 for length(old))) -- replace prefix
2940
FROM util.schema_bundle_get_schemas($1) f (old_schema);
2941
SELECT NULL::void; -- don't fold away functions called in previous query
2942
$_$;
2943

    
2944

    
2945
--
2946
-- Name: schema_bundle_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
2947
--
2948

    
2949
CREATE FUNCTION schema_bundle_replace(replace text, with_ text) RETURNS void
2950
    LANGUAGE plpgsql
2951
    AS $$
2952
BEGIN
2953
	-- don't schema_bundle_rm() the schema_bundle to keep!
2954
	IF replace = with_ THEN RETURN; END IF;
2955
	
2956
	PERFORM util.schema_bundle_rm(replace);
2957
	PERFORM util.schema_bundle_rename(with_, replace);
2958
END;
2959
$$;
2960

    
2961

    
2962
--
2963
-- Name: schema_bundle_rm(text); Type: FUNCTION; Schema: util; Owner: -
2964
--
2965

    
2966
CREATE FUNCTION schema_bundle_rm(schema_bundle text) RETURNS void
2967
    LANGUAGE sql
2968
    AS $_$
2969
SELECT util.schema_rm(schema)
2970
FROM util.schema_bundle_get_schemas($1) f (schema);
2971
SELECT NULL::void; -- don't fold away functions called in previous query
2972
$_$;
2973

    
2974

    
2975
--
2976
-- Name: schema_esc(anyelement); Type: FUNCTION; Schema: util; Owner: -
2977
--
2978

    
2979
CREATE FUNCTION schema_esc(type_null anyelement) RETURNS text
2980
    LANGUAGE sql STABLE
2981
    AS $_$
2982
SELECT quote_ident(util.schema($1))
2983
$_$;
2984

    
2985

    
2986
--
2987
-- Name: schema_matches(text, text); Type: FUNCTION; Schema: util; Owner: -
2988
--
2989

    
2990
CREATE FUNCTION schema_matches(schema text, schema_regexp text) RETURNS boolean
2991
    LANGUAGE sql IMMUTABLE
2992
    AS $_$
2993
SELECT $1 ~ $2 AND /*in userspace*/$1 !~ '^(?:information_schema|pg_.*)$'
2994
$_$;
2995

    
2996

    
2997
--
2998
-- Name: schema_oid(text); Type: FUNCTION; Schema: util; Owner: -
2999
--
3000

    
3001
CREATE FUNCTION schema_oid(schema text) RETURNS oid
3002
    LANGUAGE sql STABLE
3003
    AS $_$
3004
SELECT oid FROM pg_namespace WHERE nspname = $1
3005
$_$;
3006

    
3007

    
3008
--
3009
-- Name: schema_regexp(regclass); Type: FUNCTION; Schema: util; Owner: -
3010
--
3011

    
3012
CREATE FUNCTION schema_regexp(relation regclass) RETURNS text
3013
    LANGUAGE sql IMMUTABLE
3014
    AS $_$
3015
SELECT util.schema_regexp(schema_anchor := $1)
3016
$_$;
3017

    
3018

    
3019
--
3020
-- Name: schema_regexp(anyelement); Type: FUNCTION; Schema: util; Owner: -
3021
--
3022

    
3023
CREATE FUNCTION schema_regexp(schema_anchor anyelement) RETURNS text
3024
    LANGUAGE sql IMMUTABLE
3025
    AS $_$
3026
SELECT util.str_equality_regexp(util.schema($1))
3027
$_$;
3028

    
3029

    
3030
--
3031
-- Name: schema_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3032
--
3033

    
3034
CREATE FUNCTION schema_rename(old text, new text) RETURNS void
3035
    LANGUAGE sql
3036
    AS $_$
3037
SELECT util.eval($$ALTER SCHEMA $$||quote_ident($1)||$$ RENAME TO $$||quote_ident($2));
3038
$_$;
3039

    
3040

    
3041
--
3042
-- Name: schema_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3043
--
3044

    
3045
CREATE FUNCTION schema_replace(replace text, with_ text) RETURNS void
3046
    LANGUAGE plpgsql
3047
    AS $$
3048
BEGIN
3049
	-- don't schema_rm() the schema to keep!
3050
	IF replace = with_ THEN RETURN; END IF;
3051
	
3052
	PERFORM util.schema_rm(replace);
3053
	PERFORM util.schema_rename(with_, replace);
3054
END;
3055
$$;
3056

    
3057

    
3058
--
3059
-- Name: schema_rm(text); Type: FUNCTION; Schema: util; Owner: -
3060
--
3061

    
3062
CREATE FUNCTION schema_rm(schema text) RETURNS void
3063
    LANGUAGE sql
3064
    AS $_$
3065
SELECT util.eval($$DROP SCHEMA IF EXISTS $$||quote_ident($1)||$$ CASCADE$$);
3066
$_$;
3067

    
3068

    
3069
--
3070
-- Name: search_path_append(text); Type: FUNCTION; Schema: util; Owner: -
3071
--
3072

    
3073
CREATE FUNCTION search_path_append(schemas text) RETURNS void
3074
    LANGUAGE sql
3075
    AS $_$
3076
SELECT util.eval(
3077
$$SET search_path TO $$||current_setting('search_path')||$$, $$||$1);
3078
$_$;
3079

    
3080

    
3081
--
3082
-- Name: set_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3083
--
3084

    
3085
CREATE FUNCTION set_col_names(table_ regclass, names regclass) RETURNS void
3086
    LANGUAGE plpgsql STRICT
3087
    AS $_$
3088
DECLARE
3089
    old text[] = ARRAY(SELECT util.col_names(table_));
3090
    new text[] = ARRAY(SELECT util.map_values(names));
3091
BEGIN
3092
    old = old[1:array_length(new, 1)]; -- truncate to same length
3093
    PERFORM util.eval($$ALTER TABLE $$||$1||$$ RENAME $$||quote_ident(key)
3094
||$$ TO $$||quote_ident(value))
3095
    FROM each(hstore(old, new))
3096
    WHERE value != key -- not same name
3097
    ;
3098
END;
3099
$_$;
3100

    
3101

    
3102
--
3103
-- Name: FUNCTION set_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3104
--
3105

    
3106
COMMENT ON FUNCTION set_col_names(table_ regclass, names regclass) IS '
3107
idempotent
3108
';
3109

    
3110

    
3111
--
3112
-- Name: set_col_names_with_metadata(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3113
--
3114

    
3115
CREATE FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) RETURNS void
3116
    LANGUAGE plpgsql STRICT
3117
    AS $_$
3118
DECLARE
3119
	row_ util.map;
3120
BEGIN
3121
	-- rename any metadata cols rather than re-adding them with new names
3122
	BEGIN
3123
		PERFORM util.set_col_names(table_, names);
3124
	EXCEPTION
3125
		WHEN array_subscript_error THEN -- selective suppress
3126
			IF SQLERRM LIKE 'arrays must have same bounds' THEN NULL;
3127
				-- metadata cols not yet added
3128
			ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM; -- rethrow
3129
			END IF;
3130
	END;
3131
	
3132
	FOR row_ IN EXECUTE $$SELECT * FROM $$||names||$$ WHERE "from" LIKE ':%'$$
3133
	LOOP
3134
		PERFORM util.mk_const_col((table_, row_."to"),
3135
			substring(row_."from" from 2));
3136
	END LOOP;
3137
	
3138
	PERFORM util.set_col_names(table_, names);
3139
END;
3140
$_$;
3141

    
3142

    
3143
--
3144
-- Name: FUNCTION set_col_names_with_metadata(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3145
--
3146

    
3147
COMMENT ON FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) IS '
3148
idempotent.
3149
the metadata mappings must be *last* in the names table.
3150
';
3151

    
3152

    
3153
--
3154
-- Name: set_col_types(regclass, col_cast[]); Type: FUNCTION; Schema: util; Owner: -
3155
--
3156

    
3157
CREATE FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) RETURNS void
3158
    LANGUAGE plpgsql STRICT
3159
    AS $_$
3160
DECLARE
3161
    sql text = $$ALTER TABLE $$||table_||$$
3162
$$||NULLIF(array_to_string(ARRAY(
3163
    SELECT
3164
    $$ALTER COLUMN $$||col_name_sql||$$ TYPE $$||target_type
3165
    ||$$ USING $$||col_name_sql||$$::$$||target_type
3166
    FROM
3167
    (
3168
        SELECT
3169
          quote_ident(col_name) AS col_name_sql
3170
        , util.col_type((table_, col_name)) AS curr_type
3171
        , type AS target_type
3172
        FROM unnest(col_casts)
3173
    ) s
3174
    WHERE curr_type != target_type
3175
), '
3176
, '), '');
3177
BEGIN
3178
    PERFORM util.debug_print_sql(sql);
3179
    EXECUTE COALESCE(sql, '');
3180
END;
3181
$_$;
3182

    
3183

    
3184
--
3185
-- Name: FUNCTION set_col_types(table_ regclass, col_casts col_cast[]); Type: COMMENT; Schema: util; Owner: -
3186
--
3187

    
3188
COMMENT ON FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) IS '
3189
idempotent
3190
';
3191

    
3192

    
3193
--
3194
-- Name: set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3195
--
3196

    
3197
CREATE FUNCTION set_comment(table_ regclass, comment text) RETURNS void
3198
    LANGUAGE sql
3199
    AS $_$
3200
SELECT util.eval($$COMMENT ON TABLE $$||$1||$$ IS $$||quote_nullable($2))
3201
$_$;
3202

    
3203

    
3204
--
3205
-- Name: set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
3206
--
3207

    
3208
CREATE FUNCTION set_search_path(search_path text, for_session boolean DEFAULT false) RETURNS void
3209
    LANGUAGE sql
3210
    AS $_$
3211
SELECT util.eval(util.mk_set_search_path($1, $2))
3212
$_$;
3213

    
3214

    
3215
--
3216
-- Name: show_create_view(regclass); Type: FUNCTION; Schema: util; Owner: -
3217
--
3218

    
3219
CREATE FUNCTION show_create_view(view_ regclass) RETURNS text
3220
    LANGUAGE sql STABLE
3221
    AS $_$
3222
SELECT $$CREATE OR REPLACE VIEW $$||$1||$$ AS $$||pg_get_viewdef($1)||$$;
3223
$$||util.show_grants_for($1)
3224
$_$;
3225

    
3226

    
3227
--
3228
-- Name: show_grants_for(regclass); Type: FUNCTION; Schema: util; Owner: -
3229
--
3230

    
3231
CREATE FUNCTION show_grants_for(table_ regclass) RETURNS text
3232
    LANGUAGE sql STABLE
3233
    AS $_$
3234
SELECT string_agg(cmd, '')
3235
FROM
3236
(
3237
	SELECT (CASE WHEN has_table_privilege(user_, $1, 'SELECT') THEN
3238
$$GRANT SELECT ON TABLE $$||$1||$$ TO $$||quote_ident(user_)||$$;
3239
$$ ELSE '' END) AS cmd
3240
	FROM util.grants_users() f (user_)
3241
) s
3242
$_$;
3243

    
3244

    
3245
--
3246
-- Name: show_relations_like(text, text, character[]); Type: FUNCTION; Schema: util; Owner: -
3247
--
3248

    
3249
CREATE FUNCTION show_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, types character[] DEFAULT ARRAY['r'::text, 'v'::text]) RETURNS SETOF regclass
3250
    LANGUAGE sql STABLE
3251
    AS $_$
3252
SELECT oid FROM pg_class
3253
WHERE relkind = ANY($3) AND relname ~ $1
3254
AND util.schema_matches(util.schema(relnamespace), $2)
3255
ORDER BY relname
3256
$_$;
3257

    
3258

    
3259
--
3260
-- Name: show_views_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3261
--
3262

    
3263
CREATE FUNCTION show_views_like(name_regexp text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regclass
3264
    LANGUAGE sql STABLE
3265
    AS $_$
3266
SELECT * FROM util.show_relations_like($1, $2, ARRAY['v'])
3267
$_$;
3268

    
3269

    
3270
--
3271
-- Name: str_equality_regexp(text); Type: FUNCTION; Schema: util; Owner: -
3272
--
3273

    
3274
CREATE FUNCTION str_equality_regexp(literal text) RETURNS text
3275
    LANGUAGE sql IMMUTABLE
3276
    AS $_$
3277
SELECT '^'||util.regexp_quote($1)||'$'
3278
$_$;
3279

    
3280

    
3281
--
3282
-- Name: table2hstore(regclass); Type: FUNCTION; Schema: util; Owner: -
3283
--
3284

    
3285
CREATE FUNCTION table2hstore(table_ regclass) RETURNS hstore
3286
    LANGUAGE plpgsql STABLE STRICT
3287
    AS $_$
3288
DECLARE
3289
    hstore hstore;
3290
BEGIN
3291
    EXECUTE $$SELECT hstore(ARRAY(SELECT unnest(ARRAY["from", "to"]) FROM $$||
3292
        table_||$$))$$ INTO STRICT hstore;
3293
    RETURN hstore;
3294
END;
3295
$_$;
3296

    
3297

    
3298
--
3299
-- Name: table_flag__get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3300
--
3301

    
3302
CREATE FUNCTION table_flag__get(table_ regclass, flag text) RETURNS boolean
3303
    LANGUAGE sql STABLE
3304
    AS $_$
3305
SELECT COUNT(*) > 0 FROM pg_constraint
3306
WHERE conrelid = $1 AND contype = 'c' AND conname = $2
3307
$_$;
3308

    
3309

    
3310
--
3311
-- Name: FUNCTION table_flag__get(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3312
--
3313

    
3314
COMMENT ON FUNCTION table_flag__get(table_ regclass, flag text) IS '
3315
gets whether a status flag is set by the presence of a table constraint
3316
';
3317

    
3318

    
3319
--
3320
-- Name: table_flag__set(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3321
--
3322

    
3323
CREATE FUNCTION table_flag__set(table_ regclass, flag text) RETURNS void
3324
    LANGUAGE sql
3325
    AS $_$
3326
SELECT util.create_if_not_exists($$ALTER TABLE $$||$1||$$ ADD CONSTRAINT $$
3327
||quote_ident($2)||$$ CHECK (true)$$)
3328
$_$;
3329

    
3330

    
3331
--
3332
-- Name: FUNCTION table_flag__set(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3333
--
3334

    
3335
COMMENT ON FUNCTION table_flag__set(table_ regclass, flag text) IS '
3336
stores a status flag by the presence of a table constraint.
3337
idempotent.
3338
';
3339

    
3340

    
3341
--
3342
-- Name: table_nulls_mapped__get(regclass); Type: FUNCTION; Schema: util; Owner: -
3343
--
3344

    
3345
CREATE FUNCTION table_nulls_mapped__get(table_ regclass) RETURNS boolean
3346
    LANGUAGE sql STABLE
3347
    AS $_$
3348
SELECT util.table_flag__get($1, 'nulls_mapped')
3349
$_$;
3350

    
3351

    
3352
--
3353
-- Name: FUNCTION table_nulls_mapped__get(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3354
--
3355

    
3356
COMMENT ON FUNCTION table_nulls_mapped__get(table_ regclass) IS '
3357
gets whether a table''s NULL-equivalent strings have been replaced with NULL
3358
';
3359

    
3360

    
3361
--
3362
-- Name: table_nulls_mapped__set(regclass); Type: FUNCTION; Schema: util; Owner: -
3363
--
3364

    
3365
CREATE FUNCTION table_nulls_mapped__set(table_ regclass) RETURNS void
3366
    LANGUAGE sql
3367
    AS $_$
3368
SELECT util.table_flag__set($1, 'nulls_mapped')
3369
$_$;
3370

    
3371

    
3372
--
3373
-- Name: FUNCTION table_nulls_mapped__set(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3374
--
3375

    
3376
COMMENT ON FUNCTION table_nulls_mapped__set(table_ regclass) IS '
3377
sets that a table''s NULL-equivalent strings have been replaced with NULL.
3378
idempotent.
3379
';
3380

    
3381

    
3382
--
3383
-- Name: to_global_col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
3384
--
3385

    
3386
CREATE FUNCTION to_global_col_names(table_ regclass) RETURNS void
3387
    LANGUAGE plpgsql STRICT
3388
    AS $_$
3389
DECLARE
3390
    row record;
3391
BEGIN
3392
    FOR row IN SELECT * FROM util.col_global_names(table_::text::regtype)
3393
    LOOP
3394
        IF row.global_name != row.name THEN
3395
            EXECUTE $$ALTER TABLE $$||table_||$$ RENAME $$
3396
                ||quote_ident(row.name)||$$ TO $$||quote_ident(row.global_name);
3397
        END IF;
3398
    END LOOP;
3399
END;
3400
$_$;
3401

    
3402

    
3403
--
3404
-- Name: FUNCTION to_global_col_names(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3405
--
3406

    
3407
COMMENT ON FUNCTION to_global_col_names(table_ regclass) IS '
3408
idempotent
3409
';
3410

    
3411

    
3412
--
3413
-- Name: trim(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3414
--
3415

    
3416
CREATE FUNCTION "trim"(table_ regclass, names regclass) RETURNS void
3417
    LANGUAGE sql
3418
    AS $_$
3419
SELECT util.drop_column(($1, col)) FROM util.added_cols($1, $2) f (col);
3420
SELECT NULL::void; -- don't fold away functions called in previous query
3421
$_$;
3422

    
3423

    
3424
--
3425
-- Name: FUNCTION "trim"(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3426
--
3427

    
3428
COMMENT ON FUNCTION "trim"(table_ regclass, names regclass) IS '
3429
trims table_ to include only columns in the original data.
3430
idempotent.
3431
';
3432

    
3433

    
3434
--
3435
-- Name: truncate(regclass); Type: FUNCTION; Schema: util; Owner: -
3436
--
3437

    
3438
CREATE FUNCTION truncate(table_ regclass) RETURNS void
3439
    LANGUAGE plpgsql STRICT
3440
    AS $_$
3441
BEGIN
3442
    EXECUTE $$TRUNCATE $$||table_||$$ CASCADE$$;
3443
END;
3444
$_$;
3445

    
3446

    
3447
--
3448
-- Name: FUNCTION truncate(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3449
--
3450

    
3451
COMMENT ON FUNCTION truncate(table_ regclass) IS '
3452
idempotent
3453
';
3454

    
3455

    
3456
--
3457
-- Name: truncated_prefixed_name_regexp(text, integer); Type: FUNCTION; Schema: util; Owner: -
3458
--
3459

    
3460
CREATE FUNCTION truncated_prefixed_name_regexp(name text, max_prefix_len integer) RETURNS text
3461
    LANGUAGE sql IMMUTABLE
3462
    AS $_$
3463
SELECT '^(.*)'||util._if(util.name_was_truncated($1, $2),
3464
util.regexp_quote(util.rtrim_n($1, $2))||'.*', util.regexp_quote($1)) ||'$'
3465
$_$;
3466

    
3467

    
3468
--
3469
-- Name: try_create(text); Type: FUNCTION; Schema: util; Owner: -
3470
--
3471

    
3472
CREATE FUNCTION try_create(sql text) RETURNS void
3473
    LANGUAGE plpgsql STRICT
3474
    AS $$
3475
BEGIN
3476
    PERFORM util.eval(sql);
3477
EXCEPTION
3478
    WHEN wrong_object_type THEN NULL; -- trying to alter a view's columns
3479
    WHEN undefined_column THEN NULL;
3480
    WHEN duplicate_column THEN NULL;
3481
END;
3482
$$;
3483

    
3484

    
3485
--
3486
-- Name: FUNCTION try_create(sql text); Type: COMMENT; Schema: util; Owner: -
3487
--
3488

    
3489
COMMENT ON FUNCTION try_create(sql text) IS '
3490
idempotent
3491
';
3492

    
3493

    
3494
--
3495
-- Name: try_mk_derived_col(col_ref, text); Type: FUNCTION; Schema: util; Owner: -
3496
--
3497

    
3498
CREATE FUNCTION try_mk_derived_col(col col_ref, expr text) RETURNS void
3499
    LANGUAGE sql
3500
    AS $_$
3501
SELECT util.try_create($$SELECT util.mk_derived_col($$||quote_literal($1)||$$, $$||quote_literal($2)||$$)$$)
3502
$_$;
3503

    
3504

    
3505
--
3506
-- Name: FUNCTION try_mk_derived_col(col col_ref, expr text); Type: COMMENT; Schema: util; Owner: -
3507
--
3508

    
3509
COMMENT ON FUNCTION try_mk_derived_col(col col_ref, expr text) IS '
3510
idempotent
3511
';
3512

    
3513

    
3514
--
3515
-- Name: type_qual(anyelement); Type: FUNCTION; Schema: util; Owner: -
3516
--
3517

    
3518
CREATE FUNCTION type_qual(value anyelement) RETURNS text
3519
    LANGUAGE sql IMMUTABLE
3520
    AS $_$
3521
SELECT CASE WHEN $1 IS NULL THEN '' ELSE $$ NOT NULL$$ END
3522
$_$;
3523

    
3524

    
3525
--
3526
-- Name: FUNCTION type_qual(value anyelement); Type: COMMENT; Schema: util; Owner: -
3527
--
3528

    
3529
COMMENT ON FUNCTION type_qual(value anyelement) IS '
3530
a type''s NOT NULL qualifier
3531
';
3532

    
3533

    
3534
--
3535
-- Name: typeof(anyelement); Type: FUNCTION; Schema: util; Owner: -
3536
--
3537

    
3538
CREATE FUNCTION typeof(value anyelement) RETURNS text
3539
    LANGUAGE sql IMMUTABLE
3540
    AS $_$
3541
SELECT util.qual_name(pg_typeof($1))
3542
$_$;
3543

    
3544

    
3545
--
3546
-- Name: typeof(text, regtype); Type: FUNCTION; Schema: util; Owner: -
3547
--
3548

    
3549
CREATE FUNCTION typeof(expr text, table_ regtype DEFAULT NULL::regtype) RETURNS regtype
3550
    LANGUAGE plpgsql STABLE
3551
    AS $_$
3552
DECLARE
3553
    type regtype;
3554
BEGIN
3555
    EXECUTE $$SELECT pg_typeof($$||expr||$$)$$||
3556
COALESCE($$ FROM (SELECT (NULL::$$||table_||$$).*) _s$$, '') INTO STRICT type;
3557
    RETURN type;
3558
END;
3559
$_$;
3560

    
3561

    
3562
--
3563
-- Name: use_schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3564
--
3565

    
3566
CREATE FUNCTION use_schema(schema_anchor anyelement) RETURNS void
3567
    LANGUAGE sql
3568
    AS $_$
3569
SELECT util.set_search_path(util.mk_search_path(util.schema($1)))
3570
$_$;
3571

    
3572

    
3573
--
3574
-- Name: FUNCTION use_schema(schema_anchor anyelement); Type: COMMENT; Schema: util; Owner: -
3575
--
3576

    
3577
COMMENT ON FUNCTION use_schema(schema_anchor anyelement) IS '
3578
auto-appends util to the search_path to enable use of util operators
3579
';
3580

    
3581

    
3582
--
3583
-- Name: all_same(anyelement); Type: AGGREGATE; Schema: util; Owner: -
3584
--
3585

    
3586
CREATE AGGREGATE all_same(anyelement) (
3587
    SFUNC = all_same_transform,
3588
    STYPE = anyarray,
3589
    FINALFUNC = all_same_final
3590
);
3591

    
3592

    
3593
--
3594
-- Name: AGGREGATE all_same(anyelement); Type: COMMENT; Schema: util; Owner: -
3595
--
3596

    
3597
COMMENT ON AGGREGATE all_same(anyelement) IS '
3598
includes NULLs in comparison
3599
';
3600

    
3601

    
3602
--
3603
-- Name: join_strs(text, text); Type: AGGREGATE; Schema: util; Owner: -
3604
--
3605

    
3606
CREATE AGGREGATE join_strs(text, text) (
3607
    SFUNC = join_strs_transform,
3608
    STYPE = text
3609
);
3610

    
3611

    
3612
--
3613
-- Name: %==; Type: OPERATOR; Schema: util; Owner: -
3614
--
3615

    
3616
CREATE OPERATOR %== (
3617
    PROCEDURE = "%==",
3618
    LEFTARG = anyelement,
3619
    RIGHTARG = anyelement
3620
);
3621

    
3622

    
3623
--
3624
-- Name: OPERATOR %== (anyelement, anyelement); Type: COMMENT; Schema: util; Owner: -
3625
--
3626

    
3627
COMMENT ON OPERATOR %== (anyelement, anyelement) IS '
3628
returns whether the map-keys of the compared values are the same
3629
(mnemonic: % is the Perl symbol for a hash map)
3630

    
3631
should be overridden for types that store both keys and values
3632

    
3633
used in a FULL JOIN to select which columns to join on
3634
';
3635

    
3636

    
3637
--
3638
-- Name: ->; Type: OPERATOR; Schema: util; Owner: -
3639
--
3640

    
3641
CREATE OPERATOR -> (
3642
    PROCEDURE = map_get,
3643
    LEFTARG = regclass,
3644
    RIGHTARG = text
3645
);
3646

    
3647

    
3648
--
3649
-- Name: =>; Type: OPERATOR; Schema: util; Owner: -
3650
--
3651

    
3652
CREATE OPERATOR => (
3653
    PROCEDURE = hstore,
3654
    LEFTARG = text[],
3655
    RIGHTARG = text
3656
);
3657

    
3658

    
3659
--
3660
-- Name: OPERATOR => (text[], text); Type: COMMENT; Schema: util; Owner: -
3661
--
3662

    
3663
COMMENT ON OPERATOR => (text[], text) IS '
3664
usage: array[''key1'', ...]::text[] => ''value''
3665
';
3666

    
3667

    
3668
--
3669
-- Name: ?*>=; Type: OPERATOR; Schema: util; Owner: -
3670
--
3671

    
3672
CREATE OPERATOR ?*>= (
3673
    PROCEDURE = is_populated_more_often_than,
3674
    LEFTARG = anyelement,
3675
    RIGHTARG = anyelement
3676
);
3677

    
3678

    
3679
--
3680
-- Name: ?>=; Type: OPERATOR; Schema: util; Owner: -
3681
--
3682

    
3683
CREATE OPERATOR ?>= (
3684
    PROCEDURE = is_more_complete_than,
3685
    LEFTARG = anyelement,
3686
    RIGHTARG = anyelement
3687
);
3688

    
3689

    
3690
--
3691
-- Name: ||%; Type: OPERATOR; Schema: util; Owner: -
3692
--
3693

    
3694
CREATE OPERATOR ||% (
3695
    PROCEDURE = concat_esc,
3696
    LEFTARG = text,
3697
    RIGHTARG = text
3698
);
3699

    
3700

    
3701
--
3702
-- Name: OPERATOR ||% (text, text); Type: COMMENT; Schema: util; Owner: -
3703
--
3704

    
3705
COMMENT ON OPERATOR ||% (text, text) IS '
3706
% indicates an identifier, as in Perl hashes and one of the x86 assembler syntaxes for registers
3707
';
3708

    
3709

    
3710
--
3711
-- Name: map; Type: TABLE; Schema: util; Owner: -; Tablespace: 
3712
--
3713

    
3714
CREATE TABLE map (
3715
    "from" text NOT NULL,
3716
    "to" text,
3717
    filter text,
3718
    notes text
3719
);
3720

    
3721

    
3722
--
3723
-- Data for Name: explain; Type: TABLE DATA; Schema: util; Owner: -
3724
--
3725

    
3726

    
3727

    
3728
--
3729
-- Data for Name: map; Type: TABLE DATA; Schema: util; Owner: -
3730
--
3731

    
3732

    
3733

    
3734
--
3735
-- Name: map__unique__from; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
3736
--
3737

    
3738
ALTER TABLE ONLY map
3739
    ADD CONSTRAINT map__unique__from UNIQUE ("from");
3740

    
3741

    
3742
--
3743
-- Name: map__unique__to; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
3744
--
3745

    
3746
ALTER TABLE ONLY map
3747
    ADD CONSTRAINT map__unique__to UNIQUE ("to");
3748

    
3749

    
3750
--
3751
-- Name: map_filter_insert; Type: TRIGGER; Schema: util; Owner: -
3752
--
3753

    
3754
CREATE TRIGGER map_filter_insert BEFORE INSERT ON map FOR EACH ROW EXECUTE PROCEDURE map_filter_insert();
3755

    
3756

    
3757
--
3758
-- PostgreSQL database dump complete
3759
--
3760

    
(19-19/29)