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: auto_rm_freq(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
683
--
684

    
685
CREATE FUNCTION auto_rm_freq(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS void
686
    LANGUAGE sql
687
    AS $_$
688
SELECT CASE WHEN util.freq_always_1($1, $2)
689
THEN util.drop_column($1, $2, force := true)
690
END
691
$_$;
692

    
693

    
694
--
695
-- Name: cluster_index(regclass); Type: FUNCTION; Schema: util; Owner: -
696
--
697

    
698
CREATE FUNCTION cluster_index(table_ regclass) RETURNS regclass
699
    LANGUAGE sql STABLE
700
    AS $_$
701
SELECT indexrelid FROM pg_index WHERE indrelid = $1 AND indisclustered
702
$_$;
703

    
704

    
705
--
706
-- Name: cluster_once(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
707
--
708

    
709
CREATE FUNCTION cluster_once(table_ regclass, index regclass) RETURNS void
710
    LANGUAGE plpgsql STRICT
711
    AS $_$
712
BEGIN
713
    -- not yet clustered (ARRAY[] compares NULLs literally)
714
    IF ARRAY[util.cluster_index(table_)] != ARRAY[index] THEN
715
        EXECUTE $$CLUSTER $$||table_||$$ USING $$||index;
716
    END IF;
717
END;
718
$_$;
719

    
720

    
721
--
722
-- Name: FUNCTION cluster_once(table_ regclass, index regclass); Type: COMMENT; Schema: util; Owner: -
723
--
724

    
725
COMMENT ON FUNCTION cluster_once(table_ regclass, index regclass) IS '
726
idempotent
727
';
728

    
729

    
730
--
731
-- Name: col__min(col_ref); Type: FUNCTION; Schema: util; Owner: -
732
--
733

    
734
CREATE FUNCTION col__min(col col_ref) RETURNS integer
735
    LANGUAGE sql STABLE
736
    AS $_$
737
SELECT util.eval2val($$
738
SELECT $$||quote_ident($1.name)||$$
739
FROM $$||$1.table_||$$
740
ORDER BY $$||quote_ident($1.name)||$$ ASC
741
LIMIT 1
742
$$, NULL::integer)
743
$_$;
744

    
745

    
746
--
747
-- Name: col_comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
748
--
749

    
750
CREATE FUNCTION col_comment(col col_ref) RETURNS text
751
    LANGUAGE plpgsql STABLE STRICT
752
    AS $$
753
DECLARE
754
	comment text;
755
BEGIN
756
	SELECT description
757
	FROM pg_attribute
758
	LEFT JOIN pg_description ON objoid = attrelid
759
		AND classoid = 'pg_class'::regclass AND objsubid = attnum
760
	WHERE attrelid = col.table_ AND attname = col.name
761
	INTO STRICT comment
762
	;
763
	RETURN comment;
764
EXCEPTION
765
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
766
END;
767
$$;
768

    
769

    
770
--
771
-- Name: col_default_sql(col_ref); Type: FUNCTION; Schema: util; Owner: -
772
--
773

    
774
CREATE FUNCTION col_default_sql(col col_ref) RETURNS text
775
    LANGUAGE plpgsql STABLE STRICT
776
    AS $$
777
DECLARE
778
	default_sql text;
779
BEGIN
780
	SELECT adsrc
781
	FROM pg_attribute
782
	LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum
783
	WHERE attrelid = col.table_ AND attname = col.name
784
	INTO STRICT default_sql
785
	;
786
	RETURN default_sql;
787
EXCEPTION
788
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
789
END;
790
$$;
791

    
792

    
793
--
794
-- Name: col_default_value(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
795
--
796

    
797
CREATE FUNCTION col_default_value(col col_ref, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
798
    LANGUAGE sql STABLE
799
    AS $_$
800
SELECT util.eval_expr_passthru(util.col_default_sql($1), $2)
801
$_$;
802

    
803

    
804
--
805
-- Name: FUNCTION col_default_value(col col_ref, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
806
--
807

    
808
COMMENT ON FUNCTION col_default_value(col col_ref, ret_type_null anyelement) IS '
809
ret_type_null: NULL::ret_type
810
';
811

    
812

    
813
--
814
-- Name: col_exists(col_ref); Type: FUNCTION; Schema: util; Owner: -
815
--
816

    
817
CREATE FUNCTION col_exists(col col_ref) RETURNS boolean
818
    LANGUAGE plpgsql STRICT
819
    AS $$
820
BEGIN
821
    PERFORM util.col_type(col);
822
    RETURN true;
823
EXCEPTION
824
    WHEN undefined_column THEN RETURN false;
825
END;
826
$$;
827

    
828

    
829
--
830
-- Name: col_global_names(regtype); Type: FUNCTION; Schema: util; Owner: -
831
--
832

    
833
CREATE FUNCTION col_global_names(type regtype, OUT name text, OUT global_name text) RETURNS SETOF record
834
    LANGUAGE plpgsql STABLE STRICT
835
    AS $$
836
DECLARE
837
    prefix text := util.name(type)||'.';
838
BEGIN
839
    RETURN QUERY
840
        SELECT name_, (CASE WHEN util.contains(search_for:='.', in_str:=name_) THEN '' ELSE prefix END)||name_
841
        FROM util.col_names(type) f (name_);
842
END;
843
$$;
844

    
845

    
846
--
847
-- Name: col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
848
--
849

    
850
CREATE FUNCTION col_names(table_ regclass) RETURNS SETOF text
851
    LANGUAGE sql STABLE
852
    AS $_$
853
SELECT attname::text
854
FROM pg_attribute
855
WHERE attrelid = $1 AND attnum >= 1 AND NOT attisdropped
856
ORDER BY attnum
857
$_$;
858

    
859

    
860
--
861
-- Name: col_names(regtype); Type: FUNCTION; Schema: util; Owner: -
862
--
863

    
864
CREATE FUNCTION col_names(type regtype) RETURNS SETOF text
865
    LANGUAGE plpgsql STABLE STRICT
866
    AS $_$
867
BEGIN
868
    RETURN QUERY EXECUTE $$SELECT skeys(hstore(NULL::$$||type||$$))$$;
869
END;
870
$_$;
871

    
872

    
873
--
874
-- Name: col_type(col_ref); Type: FUNCTION; Schema: util; Owner: -
875
--
876

    
877
CREATE FUNCTION col_type(col col_ref) RETURNS regtype
878
    LANGUAGE plpgsql STABLE STRICT
879
    AS $$
880
DECLARE
881
    type regtype;
882
BEGIN
883
    SELECT atttypid FROM pg_attribute
884
    WHERE attrelid = col.table_ AND attname = col.name
885
    INTO STRICT type
886
    ;
887
    RETURN type;
888
EXCEPTION
889
    WHEN no_data_found THEN
890
        RAISE undefined_column USING MESSAGE =
891
            concat('undefined column: ', col.name);
892
END;
893
$$;
894

    
895

    
896
--
897
-- Name: comment(oid); Type: FUNCTION; Schema: util; Owner: -
898
--
899

    
900
CREATE FUNCTION comment(element oid) RETURNS text
901
    LANGUAGE sql STABLE
902
    AS $_$
903
SELECT description FROM pg_description WHERE objoid = $1
904
$_$;
905

    
906

    
907
--
908
-- Name: concat_esc(text, text); Type: FUNCTION; Schema: util; Owner: -
909
--
910

    
911
CREATE FUNCTION concat_esc("left" text, "right" text) RETURNS text
912
    LANGUAGE sql IMMUTABLE
913
    AS $_$
914
SELECT util.esc_name__append($2, $1)
915
$_$;
916

    
917

    
918
--
919
-- Name: contains(text, text); Type: FUNCTION; Schema: util; Owner: -
920
--
921

    
922
CREATE FUNCTION contains(search_for text, in_str text) RETURNS boolean
923
    LANGUAGE sql IMMUTABLE
924
    AS $_$
925
SELECT position($1 in $2) > 0 /*1-based offset*/
926
$_$;
927

    
928

    
929
--
930
-- Name: copy_struct(regclass, text); Type: FUNCTION; Schema: util; Owner: -
931
--
932

    
933
CREATE FUNCTION copy_struct(from_ regclass, to_ text) RETURNS void
934
    LANGUAGE sql
935
    AS $_$
936
SELECT util.eval($$CREATE TABLE $$||$2||$$ (LIKE $$||$1||$$ INCLUDING ALL)$$)
937
$_$;
938

    
939

    
940
--
941
-- Name: copy_types_and_data(regclass, text); Type: FUNCTION; Schema: util; Owner: -
942
--
943

    
944
CREATE FUNCTION copy_types_and_data(from_ regclass, to_ text) RETURNS void
945
    LANGUAGE sql
946
    AS $_$
947
SELECT util.materialize_view($2, $1)
948
$_$;
949

    
950

    
951
--
952
-- Name: create_if_not_exists(text); Type: FUNCTION; Schema: util; Owner: -
953
--
954

    
955
CREATE FUNCTION create_if_not_exists(sql text) RETURNS void
956
    LANGUAGE plpgsql STRICT
957
    AS $$
958
BEGIN
959
	PERFORM util.eval(sql);
960
EXCEPTION
961
WHEN duplicate_table THEN NULL;
962
WHEN duplicate_object THEN NULL; -- e.g. constraint
963
WHEN duplicate_column THEN NULL;
964
WHEN duplicate_function THEN NULL;
965
WHEN invalid_table_definition THEN
966
	IF SQLERRM LIKE 'multiple primary keys for table % are not allowed' THEN NULL;
967
	ELSE RAISE;
968
	END IF;
969
END;
970
$$;
971

    
972

    
973
--
974
-- Name: FUNCTION create_if_not_exists(sql text); Type: COMMENT; Schema: util; Owner: -
975
--
976

    
977
COMMENT ON FUNCTION create_if_not_exists(sql text) IS '
978
idempotent
979
';
980

    
981

    
982
--
983
-- Name: curr_func(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
984
--
985

    
986
CREATE FUNCTION curr_func(func text, schema_anchor anyelement) RETURNS text
987
    LANGUAGE sql STABLE
988
    AS $$
989
SELECT util.schema_esc(schema_anchor)||'.'||quote_ident(func)
990
$$;
991

    
992

    
993
--
994
-- Name: debug_print_return_value(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
995
--
996

    
997
CREATE FUNCTION debug_print_return_value(value anyelement, encode boolean DEFAULT false) RETURNS anyelement
998
    LANGUAGE sql IMMUTABLE
999
    AS $_$
1000
SELECT util.raise('NOTICE', 'returns: '
1001
||(CASE WHEN $2 THEN util.quote_typed($1) ELSE $1::text END));
1002
SELECT $1;
1003
$_$;
1004

    
1005

    
1006
--
1007
-- Name: debug_print_sql(text); Type: FUNCTION; Schema: util; Owner: -
1008
--
1009

    
1010
CREATE FUNCTION debug_print_sql(sql text) RETURNS void
1011
    LANGUAGE sql IMMUTABLE
1012
    AS $_$
1013
/* newline before so the query starts at the beginning of the line.
1014
newline after to visually separate queries from one another. */
1015
SELECT util.raise('NOTICE', $$
1016
$$||util.runnable_sql($1)||$$
1017
$$||COALESCE(util.explain2notice_msg_if_can($1), ''))
1018
$_$;
1019

    
1020

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

    
1025
CREATE FUNCTION derived_cols(table_ regclass, names regclass) RETURNS SETOF text
1026
    LANGUAGE sql STABLE
1027
    AS $_$
1028
SELECT util.eval2set($$
1029
SELECT col
1030
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
1031
LEFT JOIN $$||$2||$$ ON "to" = col
1032
WHERE "from" IS NULL
1033
$$, NULL::text)
1034
$_$;
1035

    
1036

    
1037
--
1038
-- Name: FUNCTION derived_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
1039
--
1040

    
1041
COMMENT ON FUNCTION derived_cols(table_ regclass, names regclass) IS '
1042
gets table_''s derived columns (all the columns not in the names table)
1043
';
1044

    
1045

    
1046
--
1047
-- Name: diff(regclass, regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
1048
--
1049

    
1050
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1051
    LANGUAGE sql
1052
    AS $_$
1053
-- create a diff when the # of copies of a row differs between the tables
1054
SELECT util.to_freq($1);
1055
SELECT util.to_freq($2);
1056
SELECT util.auto_rm_freq(ARRAY[$1, $2]);
1057
SELECT util.try_create($$ALTER TABLE $$||util.typeof($3)||$$ ADD COLUMN copies bigint NOT NULL$$);
1058

    
1059
SELECT * FROM util.diff($1, $2, $3, has_freq := true)
1060
$_$;
1061

    
1062

    
1063
--
1064
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1065
--
1066

    
1067
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1068
usage:
1069
SELECT * FROM util.diff(''"left_table"''::regclass, ''"right_table"''::regclass, NULL::shared_base_type)
1070

    
1071
col_type_null (*required*): NULL::shared_base_type
1072
';
1073

    
1074

    
1075
--
1076
-- Name: diff(text, text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1077
--
1078

    
1079
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
1080
    LANGUAGE plpgsql
1081
    SET search_path TO pg_temp
1082
    AS $_$
1083
/* must use LANGUAGE plpgsql because LANGUAGE sql does not support runtime
1084
changes of search_path (schema elements are bound at inline time rather than
1085
runtime) */
1086
/* function option search_path is needed to limit the effects of
1087
`SET LOCAL search_path` to the current function */
1088
BEGIN
1089
	PERFORM util.use_schema($3); -- includes util.%== as default/fallback
1090
	
1091
	PERFORM util.mk_keys_func(pg_typeof($3));
1092
	RETURN QUERY
1093
		SELECT * FROM util.eval2col_pair(util.mk_diff_query($1, $2,
1094
$$/* need to explicitly cast each side to the return type because this does not
1095
happen automatically even when an implicit cast is available */
1096
  left_::$$||util.typeof($3)||$$
1097
, right_::$$||util.typeof($3)
1098
/* when using the util.%==(anyelement, anyelement) operator, you must cast to
1099
the *same* base type, *even though* this is optional when using a custom %== */
1100
, util._if($4, $$true/*= CROSS JOIN*/$$,
1101
$$ left_::$$||util.typeof($3)||$$
1102
%== right_::$$||util.typeof($3)||$$
1103
	-- refer to EXPLAIN output for expansion of %==$$
1104
)
1105
,     $$         left_::$$||util.typeof($3)||$$
1106
IS DISTINCT FROM right_::$$||util.typeof($3)
1107
), $3)
1108
	;
1109
END;
1110
$_$;
1111

    
1112

    
1113
--
1114
-- 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: -
1115
--
1116

    
1117
COMMENT ON FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1118
col_type_null (*required*): NULL::col_type
1119
single_row: whether the tables consist of a single row, which should be
1120
	displayed side-by-side
1121

    
1122
to match up rows using a subset of the columns, create a custom keys() function
1123
which returns this subset as a record:
1124
-- note that OUT parameters for the returned fields are *not* needed
1125
CREATE OR REPLACE FUNCTION [schema].keys(value [schema].[base_type])
1126
  RETURNS record AS
1127
$BODY$
1128
SELECT ($1.key_field_0, $1.key_field_1)
1129
$BODY$
1130
  LANGUAGE sql IMMUTABLE
1131
  COST 100;
1132

    
1133

    
1134
to run EXPLAIN on the FULL JOIN query:
1135
# run this function
1136
# look for a NOTICE containing the expanded query that it ran
1137
# run EXPLAIN on this expanded query
1138
';
1139

    
1140

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

    
1145
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1146
    LANGUAGE sql
1147
    AS $_$
1148
SELECT * FROM util.diff($1::text, $2::text, $3,
1149
	single_row := util.has_single_row($1) AND util.has_single_row($2))
1150
$_$;
1151

    
1152

    
1153
--
1154
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1155
--
1156

    
1157
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1158
helper function used by diff(regclass, regclass)
1159

    
1160
usage:
1161
SELECT * FROM util.diff(''"left_freq_table"''::regclass, ''"right_freq_table"''::regclass, NULL::shared_base_type, has_freq := true)
1162

    
1163
col_type_null (*required*): NULL::shared_base_type
1164
';
1165

    
1166

    
1167
--
1168
-- Name: do_optionally_ignore(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1169
--
1170

    
1171
CREATE FUNCTION do_optionally_ignore(sql text, ignore boolean) RETURNS void
1172
    LANGUAGE sql
1173
    AS $_$
1174
SELECT CASE WHEN $2 THEN util.try_create($1) ELSE util.create_if_not_exists($1) END
1175
$_$;
1176

    
1177

    
1178
--
1179
-- Name: FUNCTION do_optionally_ignore(sql text, ignore boolean); Type: COMMENT; Schema: util; Owner: -
1180
--
1181

    
1182
COMMENT ON FUNCTION do_optionally_ignore(sql text, ignore boolean) IS '
1183
idempotent
1184
';
1185

    
1186

    
1187
--
1188
-- Name: drop_column(col_ref, boolean); Type: FUNCTION; Schema: util; Owner: -
1189
--
1190

    
1191
CREATE FUNCTION drop_column(col col_ref, force boolean DEFAULT false) RETURNS void
1192
    LANGUAGE sql
1193
    AS $_$
1194
SELECT util.eval($$ALTER TABLE $$||$1.table_||$$ DROP COLUMN IF EXISTS $$||
1195
quote_ident($1.name)||util._if($2, $$ CASCADE$$, ''::text))
1196
$_$;
1197

    
1198

    
1199
--
1200
-- Name: FUNCTION drop_column(col col_ref, force boolean); Type: COMMENT; Schema: util; Owner: -
1201
--
1202

    
1203
COMMENT ON FUNCTION drop_column(col col_ref, force boolean) IS '
1204
idempotent
1205
';
1206

    
1207

    
1208
--
1209
-- Name: drop_column(regclass[], text, boolean); Type: FUNCTION; Schema: util; Owner: -
1210
--
1211

    
1212
CREATE FUNCTION drop_column(tables regclass[], col text, force boolean DEFAULT false) RETURNS void
1213
    LANGUAGE sql
1214
    AS $_$
1215
SELECT util.drop_column((table_, $2), $3) FROM unnest($1) table_
1216
$_$;
1217

    
1218

    
1219
--
1220
-- Name: FUNCTION drop_column(tables regclass[], col text, force boolean); Type: COMMENT; Schema: util; Owner: -
1221
--
1222

    
1223
COMMENT ON FUNCTION drop_column(tables regclass[], col text, force boolean) IS '
1224
idempotent
1225
';
1226

    
1227

    
1228
--
1229
-- Name: drop_relation(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1230
--
1231

    
1232
CREATE FUNCTION drop_relation(relation anyelement, force boolean DEFAULT false) RETURNS void
1233
    LANGUAGE sql
1234
    AS $_$
1235
/* use util.qual_name() instead of ::text so that the schema qualifier is always
1236
included in the debug SQL */
1237
SELECT util.drop_relation(util.relation_type($1), util.qual_name($1), $2)
1238
$_$;
1239

    
1240

    
1241
--
1242
-- Name: drop_relation(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1243
--
1244

    
1245
CREATE FUNCTION drop_relation(type text, relation_esc text, force boolean DEFAULT false) RETURNS void
1246
    LANGUAGE sql
1247
    AS $_$
1248
SELECT util.eval($$DROP $$||$1||$$ IF EXISTS $$||$2
1249
||util._if($3, $$ CASCADE$$, ''::text))
1250
$_$;
1251

    
1252

    
1253
--
1254
-- Name: FUNCTION drop_relation(type text, relation_esc text, force boolean); Type: COMMENT; Schema: util; Owner: -
1255
--
1256

    
1257
COMMENT ON FUNCTION drop_relation(type text, relation_esc text, force boolean) IS '
1258
idempotent
1259
';
1260

    
1261

    
1262
--
1263
-- Name: drop_relations_like(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1264
--
1265

    
1266
CREATE FUNCTION drop_relations_like(name_regexp text, schema_anchor anyelement, force boolean DEFAULT false) RETURNS void
1267
    LANGUAGE sql
1268
    AS $_$
1269
SELECT util.drop_relations_like($1, util.schema_regexp($2), $3)
1270
$_$;
1271

    
1272

    
1273
--
1274
-- Name: drop_relations_like(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1275
--
1276

    
1277
CREATE FUNCTION drop_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, force boolean DEFAULT false) RETURNS void
1278
    LANGUAGE sql
1279
    AS $_$
1280
SELECT util.debug_print_sql(util.quote_func_call('util.drop_relations_like',
1281
util.quote_typed($1), util.quote_typed($2), util.quote_typed($3)))
1282
;
1283
SELECT util.drop_relation(relation, $3)
1284
FROM util.show_relations_like($1, $2) relation
1285
;
1286
SELECT NULL::void; -- don't fold away functions called in previous query
1287
$_$;
1288

    
1289

    
1290
--
1291
-- Name: drop_table(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1292
--
1293

    
1294
CREATE FUNCTION drop_table(table_ text, force boolean DEFAULT false) RETURNS void
1295
    LANGUAGE sql
1296
    AS $_$
1297
SELECT util.drop_relation('TABLE', $1, $2)
1298
$_$;
1299

    
1300

    
1301
--
1302
-- Name: FUNCTION drop_table(table_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1303
--
1304

    
1305
COMMENT ON FUNCTION drop_table(table_ text, force boolean) IS '
1306
idempotent
1307
';
1308

    
1309

    
1310
--
1311
-- Name: drop_view(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1312
--
1313

    
1314
CREATE FUNCTION drop_view(view_ text, force boolean DEFAULT false) RETURNS void
1315
    LANGUAGE sql
1316
    AS $_$
1317
SELECT util.drop_relation('VIEW', $1, $2)
1318
$_$;
1319

    
1320

    
1321
--
1322
-- Name: FUNCTION drop_view(view_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1323
--
1324

    
1325
COMMENT ON FUNCTION drop_view(view_ text, force boolean) IS '
1326
idempotent
1327
';
1328

    
1329

    
1330
--
1331
-- Name: empty_array(anyelement); Type: FUNCTION; Schema: util; Owner: -
1332
--
1333

    
1334
CREATE FUNCTION empty_array(elem_type_null anyelement DEFAULT NULL::text) RETURNS anyarray
1335
    LANGUAGE sql IMMUTABLE
1336
    AS $_$
1337
SELECT util.array_fill($1, 0)
1338
$_$;
1339

    
1340

    
1341
--
1342
-- Name: FUNCTION empty_array(elem_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1343
--
1344

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

    
1349

    
1350
--
1351
-- Name: ensure_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1352
--
1353

    
1354
CREATE FUNCTION ensure_prefix(prefix text, str text) RETURNS text
1355
    LANGUAGE sql IMMUTABLE
1356
    AS $_$
1357
SELECT (CASE WHEN util.has_prefix($1, $2) THEN $2 ELSE $1||$2 END)
1358
$_$;
1359

    
1360

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

    
1365
CREATE FUNCTION esc_name__append(suffix text, esc_name text) RETURNS text
1366
    LANGUAGE sql IMMUTABLE
1367
    AS $_$
1368
SELECT regexp_replace($2, '("?)$', $1||'\1')
1369
$_$;
1370

    
1371

    
1372
--
1373
-- Name: eval(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1374
--
1375

    
1376
CREATE FUNCTION eval(sql text, verbose_ boolean DEFAULT true) RETURNS void
1377
    LANGUAGE plpgsql
1378
    AS $$
1379
BEGIN
1380
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1381
	EXECUTE sql;
1382
END;
1383
$$;
1384

    
1385

    
1386
--
1387
-- Name: eval2col_pair(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1388
--
1389

    
1390
CREATE FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1391
    LANGUAGE plpgsql
1392
    AS $$
1393
BEGIN
1394
	PERFORM util.debug_print_sql(sql);
1395
	RETURN QUERY EXECUTE sql;
1396
END;
1397
$$;
1398

    
1399

    
1400
--
1401
-- Name: FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1402
--
1403

    
1404
COMMENT ON FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1405
col_type_null (*required*): NULL::col_type
1406
';
1407

    
1408

    
1409
--
1410
-- Name: eval2records(text); Type: FUNCTION; Schema: util; Owner: -
1411
--
1412

    
1413
CREATE FUNCTION eval2records(sql text) RETURNS SETOF record
1414
    LANGUAGE plpgsql
1415
    AS $$
1416
BEGIN
1417
	PERFORM util.debug_print_sql(sql);
1418
	RETURN QUERY EXECUTE sql;
1419
END;
1420
$$;
1421

    
1422

    
1423
--
1424
-- Name: eval2set(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1425
--
1426

    
1427
CREATE FUNCTION eval2set(sql text, ret_type_null anyelement DEFAULT NULL::text, verbose_ boolean DEFAULT true) RETURNS SETOF anyelement
1428
    LANGUAGE plpgsql
1429
    AS $$
1430
BEGIN
1431
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1432
	RETURN QUERY EXECUTE sql;
1433
END;
1434
$$;
1435

    
1436

    
1437
--
1438
-- Name: eval2val(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1439
--
1440

    
1441
CREATE FUNCTION eval2val(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1442
    LANGUAGE plpgsql STABLE
1443
    AS $$
1444
DECLARE
1445
	ret_val ret_type_null%TYPE;
1446
BEGIN
1447
	PERFORM util.debug_print_sql(sql);
1448
	EXECUTE sql INTO STRICT ret_val;
1449
	RETURN ret_val;
1450
END;
1451
$$;
1452

    
1453

    
1454
--
1455
-- Name: FUNCTION eval2val(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1456
--
1457

    
1458
COMMENT ON FUNCTION eval2val(sql text, ret_type_null anyelement) IS '
1459
ret_type_null: NULL::ret_type
1460
';
1461

    
1462

    
1463
--
1464
-- Name: eval_expr(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1465
--
1466

    
1467
CREATE FUNCTION eval_expr(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1468
    LANGUAGE sql
1469
    AS $_$
1470
SELECT util.eval2val($$SELECT $$||$1, $2)
1471
$_$;
1472

    
1473

    
1474
--
1475
-- Name: FUNCTION eval_expr(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1476
--
1477

    
1478
COMMENT ON FUNCTION eval_expr(sql text, ret_type_null anyelement) IS '
1479
ret_type_null: NULL::ret_type
1480
';
1481

    
1482

    
1483
--
1484
-- Name: eval_expr_passthru(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1485
--
1486

    
1487
CREATE FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1488
    LANGUAGE sql
1489
    AS $_$
1490
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE util.eval_expr($1, $2) END
1491
$_$;
1492

    
1493

    
1494
--
1495
-- Name: FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1496
--
1497

    
1498
COMMENT ON FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement) IS '
1499
sql: can be NULL, which will be passed through
1500
ret_type_null: NULL::ret_type
1501
';
1502

    
1503

    
1504
--
1505
-- Name: existing_cols(regclass, text[]); Type: FUNCTION; Schema: util; Owner: -
1506
--
1507

    
1508
CREATE FUNCTION existing_cols(table_ regclass, VARIADIC col_names text[]) RETURNS SETOF text
1509
    LANGUAGE sql STABLE
1510
    AS $_$
1511
SELECT col_name
1512
FROM unnest($2) s (col_name)
1513
WHERE util.col_exists(($1, col_name))
1514
$_$;
1515

    
1516

    
1517
--
1518
-- Name: explain(text); Type: FUNCTION; Schema: util; Owner: -
1519
--
1520

    
1521
CREATE FUNCTION explain(sql text) RETURNS SETOF text
1522
    LANGUAGE sql
1523
    AS $_$
1524
SELECT util.eval2set($$EXPLAIN $$||$1, verbose_ := false)
1525
$_$;
1526

    
1527

    
1528
--
1529
-- Name: explain2notice(text); Type: FUNCTION; Schema: util; Owner: -
1530
--
1531

    
1532
CREATE FUNCTION explain2notice(sql text) RETURNS void
1533
    LANGUAGE sql
1534
    AS $_$
1535
SELECT util.raise('NOTICE', util.explain2notice_msg($1))
1536
$_$;
1537

    
1538

    
1539
--
1540
-- Name: explain2notice_msg(text); Type: FUNCTION; Schema: util; Owner: -
1541
--
1542

    
1543
CREATE FUNCTION explain2notice_msg(sql text) RETURNS text
1544
    LANGUAGE sql
1545
    AS $_$
1546
-- newline before and after to visually separate it from other debug info
1547
SELECT $$
1548
EXPLAIN:
1549
$$||util.explain2str($1)||$$
1550
$$
1551
$_$;
1552

    
1553

    
1554
--
1555
-- Name: explain2notice_msg_if_can(text); Type: FUNCTION; Schema: util; Owner: -
1556
--
1557

    
1558
CREATE FUNCTION explain2notice_msg_if_can(sql text) RETURNS text
1559
    LANGUAGE sql
1560
    AS $_$
1561
SELECT (CASE WHEN util.is_explainable($1) THEN util.explain2notice_msg($1) END)
1562
$_$;
1563

    
1564

    
1565
--
1566
-- Name: explain2str(text); Type: FUNCTION; Schema: util; Owner: -
1567
--
1568

    
1569
CREATE FUNCTION explain2str(sql text) RETURNS text
1570
    LANGUAGE sql
1571
    AS $_$
1572
SELECT util.join_strs(explain, $$
1573
$$) FROM util.explain($1)
1574
$_$;
1575

    
1576

    
1577
SET default_tablespace = '';
1578

    
1579
SET default_with_oids = false;
1580

    
1581
--
1582
-- Name: explain; Type: TABLE; Schema: util; Owner: -; Tablespace: 
1583
--
1584

    
1585
CREATE TABLE explain (
1586
    line text NOT NULL
1587
);
1588

    
1589

    
1590
--
1591
-- Name: explain2table(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1592
--
1593

    
1594
CREATE FUNCTION explain2table(sql text, table_ regclass DEFAULT 'explain'::regclass) RETURNS void
1595
    LANGUAGE sql
1596
    AS $_$
1597
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT util.explain(
1598
$$||quote_nullable($1)||$$
1599
)$$)
1600
$_$;
1601

    
1602

    
1603
--
1604
-- Name: FUNCTION explain2table(sql text, table_ regclass); Type: COMMENT; Schema: util; Owner: -
1605
--
1606

    
1607
COMMENT ON FUNCTION explain2table(sql text, table_ regclass) IS '
1608
usage:
1609
PERFORM util.explain2table($$
1610
query
1611
$$);
1612
';
1613

    
1614

    
1615
--
1616
-- Name: first_word(text); Type: FUNCTION; Schema: util; Owner: -
1617
--
1618

    
1619
CREATE FUNCTION first_word(str text) RETURNS text
1620
    LANGUAGE sql IMMUTABLE
1621
    AS $_$
1622
SELECT match[1] FROM regexp_matches(util.ltrim_nl($1), '^(\S*)') match
1623
$_$;
1624

    
1625

    
1626
--
1627
-- Name: fix_array(anyarray); Type: FUNCTION; Schema: util; Owner: -
1628
--
1629

    
1630
CREATE FUNCTION fix_array("array" anyarray) RETURNS anyarray
1631
    LANGUAGE sql IMMUTABLE
1632
    AS $_$
1633
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE (
1634
	CASE WHEN pg_catalog.array_ndims($1) IS NULL THEN util.empty_array($1[1]) ELSE $1 END
1635
) END
1636
$_$;
1637

    
1638

    
1639
--
1640
-- Name: FUNCTION fix_array("array" anyarray); Type: COMMENT; Schema: util; Owner: -
1641
--
1642

    
1643
COMMENT ON FUNCTION fix_array("array" anyarray) IS '
1644
ensures that an array will always have proper non-NULL dimensions
1645
';
1646

    
1647

    
1648
--
1649
-- Name: force_recreate(text, text[]); Type: FUNCTION; Schema: util; Owner: -
1650
--
1651

    
1652
CREATE FUNCTION force_recreate(cmd text, users text[] DEFAULT NULL::text[]) RETURNS void
1653
    LANGUAGE plpgsql
1654
    AS $_$
1655
DECLARE
1656
	PG_EXCEPTION_DETAIL text;
1657
	recreate_users_cmd text = util.save_drop_views(users);
1658
BEGIN
1659
	PERFORM util.eval(cmd);
1660
	PERFORM util.eval(recreate_users_cmd);
1661
EXCEPTION
1662
WHEN dependent_objects_still_exist THEN
1663
	IF users IS NOT NULL THEN RAISE; END IF; -- save_drop_views() didn't fix it
1664
	GET STACKED DIAGNOSTICS PG_EXCEPTION_DETAIL = PG_EXCEPTION_DETAIL;
1665
	users = array(SELECT * FROM util.regexp_matches_group(
1666
		PG_EXCEPTION_DETAIL, '(?m)^view (.*) depends on table .*$'));
1667
	IF util.is_empty(users) THEN RAISE; END IF;
1668
	PERFORM util.force_recreate(cmd, users);
1669
END;
1670
$_$;
1671

    
1672

    
1673
--
1674
-- Name: FUNCTION force_recreate(cmd text, users text[]); Type: COMMENT; Schema: util; Owner: -
1675
--
1676

    
1677
COMMENT ON FUNCTION force_recreate(cmd text, users text[]) IS '
1678
idempotent
1679

    
1680
users: not necessary to provide this because it will be autopopulated
1681
';
1682

    
1683

    
1684
--
1685
-- Name: force_update_view(text, text); Type: FUNCTION; Schema: util; Owner: -
1686
--
1687

    
1688
CREATE FUNCTION force_update_view(view_ text, query text) RETURNS void
1689
    LANGUAGE plpgsql STRICT
1690
    AS $_$
1691
DECLARE
1692
	mk_view text = $$CREATE OR REPLACE VIEW $$||view_||$$ AS
1693
$$||query;
1694
BEGIN
1695
	EXECUTE mk_view;
1696
EXCEPTION
1697
WHEN invalid_table_definition THEN
1698
	IF SQLERRM = 'cannot drop columns from view'
1699
	OR SQLERRM LIKE 'cannot change name of view column "%" to "%"'
1700
	THEN
1701
		EXECUTE $$DROP VIEW $$||view_||$$ CASCADE$$;
1702
		EXECUTE mk_view;
1703
	ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM;
1704
	END IF;
1705
END;
1706
$_$;
1707

    
1708

    
1709
--
1710
-- Name: FUNCTION force_update_view(view_ text, query text); Type: COMMENT; Schema: util; Owner: -
1711
--
1712

    
1713
COMMENT ON FUNCTION force_update_view(view_ text, query text) IS '
1714
idempotent
1715
';
1716

    
1717

    
1718
--
1719
-- Name: freq_always_1(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1720
--
1721

    
1722
CREATE FUNCTION freq_always_1(table_ regclass, freq_col text DEFAULT 'copies'::text) RETURNS boolean
1723
    LANGUAGE sql STABLE
1724
    AS $_$
1725
SELECT util.eval2val(
1726
$$SELECT NOT EXISTS( -- there is no row that is != 1
1727
	SELECT NULL
1728
	FROM $$||$1||$$
1729
	WHERE $$||quote_ident(freq_col)||$$ IS DISTINCT FROM 1
1730
	LIMIT 1
1731
)
1732
$$, NULL::boolean)
1733
$_$;
1734

    
1735

    
1736
--
1737
-- Name: freq_always_1(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
1738
--
1739

    
1740
CREATE FUNCTION freq_always_1(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS boolean
1741
    LANGUAGE sql STABLE
1742
    AS $_$
1743
SELECT bool_and(util.freq_always_1(table_, $2)) FROM unnest($1) table_
1744
$_$;
1745

    
1746

    
1747
--
1748
-- Name: grants_users(); Type: FUNCTION; Schema: util; Owner: -
1749
--
1750

    
1751
CREATE FUNCTION grants_users() RETURNS SETOF text
1752
    LANGUAGE sql IMMUTABLE
1753
    AS $$
1754
VALUES ('bien_read'), ('public_')
1755
$$;
1756

    
1757

    
1758
--
1759
-- Name: has_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1760
--
1761

    
1762
CREATE FUNCTION has_prefix(prefix text, str text) RETURNS boolean
1763
    LANGUAGE sql IMMUTABLE
1764
    AS $_$
1765
SELECT substring($2 for length($1)) = $1
1766
$_$;
1767

    
1768

    
1769
--
1770
-- Name: has_single_row(regclass); Type: FUNCTION; Schema: util; Owner: -
1771
--
1772

    
1773
CREATE FUNCTION has_single_row(table_ regclass) RETURNS boolean
1774
    LANGUAGE sql STABLE
1775
    AS $_$
1776
SELECT util.eval2val($$SELECT COUNT(*) = 1 FROM $$||$1, NULL::boolean)
1777
$_$;
1778

    
1779

    
1780
--
1781
-- Name: hstore(text[], text); Type: FUNCTION; Schema: util; Owner: -
1782
--
1783

    
1784
CREATE FUNCTION hstore(keys text[], value text) RETURNS hstore
1785
    LANGUAGE sql IMMUTABLE
1786
    AS $_$
1787
SELECT hstore(util.fix_array($1), util.array_fill($2, util.array_length($1)))
1788
$_$;
1789

    
1790

    
1791
--
1792
-- Name: FUNCTION hstore(keys text[], value text); Type: COMMENT; Schema: util; Owner: -
1793
--
1794

    
1795
COMMENT ON FUNCTION hstore(keys text[], value text) IS '
1796
avoids repeating the same value for each key
1797
';
1798

    
1799

    
1800
--
1801
-- Name: ifnull(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1802
--
1803

    
1804
CREATE FUNCTION ifnull(value anyelement, null_ anyelement) RETURNS anyelement
1805
    LANGUAGE sql IMMUTABLE
1806
    AS $_$
1807
SELECT COALESCE($1, $2)
1808
$_$;
1809

    
1810

    
1811
--
1812
-- Name: FUNCTION ifnull(value anyelement, null_ anyelement); Type: COMMENT; Schema: util; Owner: -
1813
--
1814

    
1815
COMMENT ON FUNCTION ifnull(value anyelement, null_ anyelement) IS '
1816
equivalent to MySQL''s IFNULL() (Postgres auto-lowercases the name)
1817
';
1818

    
1819

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

    
1824
CREATE FUNCTION inherit(derived regclass, base regclass) RETURNS void
1825
    LANGUAGE sql
1826
    AS $_$
1827
SELECT util.eval($$ALTER TABLE $$||$1||$$ INHERIT $$||$2)
1828
$_$;
1829

    
1830

    
1831
--
1832
-- Name: is_constant(col_ref); Type: FUNCTION; Schema: util; Owner: -
1833
--
1834

    
1835
CREATE FUNCTION is_constant(col col_ref) RETURNS boolean
1836
    LANGUAGE sql STABLE
1837
    AS $_$
1838
SELECT COALESCE(util.col_comment($1) LIKE 'constant%', false)
1839
$_$;
1840

    
1841

    
1842
--
1843
-- Name: is_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
1844
--
1845

    
1846
CREATE FUNCTION is_empty("array" anyarray) RETURNS boolean
1847
    LANGUAGE sql IMMUTABLE
1848
    AS $_$
1849
SELECT util.array_length($1) = 0
1850
$_$;
1851

    
1852

    
1853
--
1854
-- Name: is_explain(text); Type: FUNCTION; Schema: util; Owner: -
1855
--
1856

    
1857
CREATE FUNCTION is_explain(sql text) RETURNS boolean
1858
    LANGUAGE sql IMMUTABLE
1859
    AS $_$
1860
SELECT upper(util.first_word($1)) = 'EXPLAIN'
1861
$_$;
1862

    
1863

    
1864
--
1865
-- Name: is_explainable(text); Type: FUNCTION; Schema: util; Owner: -
1866
--
1867

    
1868
CREATE FUNCTION is_explainable(sql text) RETURNS boolean
1869
    LANGUAGE sql IMMUTABLE
1870
    AS $_$
1871
SELECT upper(util.first_word($1)) = ANY(
1872
'{SELECT,INSERT,UPDATE,DELETE,VALUES,EXECUTE,DECLARE}'::text[]
1873
/*from http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691*/
1874
)
1875
$_$;
1876

    
1877

    
1878
--
1879
-- Name: is_more_complete_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1880
--
1881

    
1882
CREATE FUNCTION is_more_complete_than("left" anyelement, "right" anyelement) RETURNS boolean
1883
    LANGUAGE sql IMMUTABLE
1884
    AS $_$
1885
SELECT $1 IS NOT DISTINCT FROM $2 OR ($1 IS NOT NULL AND $2 IS NULL)
1886
$_$;
1887

    
1888

    
1889
--
1890
-- Name: is_populated_more_often_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1891
--
1892

    
1893
CREATE FUNCTION is_populated_more_often_than("left" anyelement, "right" anyelement) RETURNS boolean
1894
    LANGUAGE sql IMMUTABLE
1895
    AS $_$
1896
SELECT $1 IS NOT NULL >= $2 IS NOT NULL -- true > false
1897
$_$;
1898

    
1899

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

    
1904
CREATE FUNCTION is_set_stmt(sql text) RETURNS boolean
1905
    LANGUAGE sql IMMUTABLE
1906
    AS $_$
1907
SELECT upper(util.first_word($1)) = 'SET'
1908
$_$;
1909

    
1910

    
1911
--
1912
-- Name: is_table(regclass); Type: FUNCTION; Schema: util; Owner: -
1913
--
1914

    
1915
CREATE FUNCTION is_table(relation regclass) RETURNS boolean
1916
    LANGUAGE sql STABLE
1917
    AS $_$
1918
SELECT relkind = 'r' FROM pg_class WHERE oid = $1
1919
$_$;
1920

    
1921

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

    
1926
CREATE FUNCTION is_view(relation regclass) RETURNS boolean
1927
    LANGUAGE sql STABLE
1928
    AS $_$
1929
SELECT relkind = 'v' FROM pg_class WHERE oid = $1
1930
$_$;
1931

    
1932

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

    
1937
CREATE FUNCTION join_strs_transform(state text, value text, delim text) RETURNS text
1938
    LANGUAGE sql IMMUTABLE STRICT
1939
    AS $_$
1940
SELECT $1 || $3 || $2
1941
$_$;
1942

    
1943

    
1944
--
1945
-- Name: FUNCTION join_strs_transform(state text, value text, delim text); Type: COMMENT; Schema: util; Owner: -
1946
--
1947

    
1948
COMMENT ON FUNCTION join_strs_transform(state text, value text, delim text) IS '
1949
must be declared STRICT to use the special handling of STRICT aggregating functions
1950
';
1951

    
1952

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

    
1957
CREATE FUNCTION keys(value anyelement) RETURNS anyelement
1958
    LANGUAGE sql IMMUTABLE
1959
    AS $_$
1960
SELECT $1 -- compare on the entire value
1961
$_$;
1962

    
1963

    
1964
--
1965
-- Name: limit2row_num(integer, integer, integer); Type: FUNCTION; Schema: util; Owner: -
1966
--
1967

    
1968
CREATE FUNCTION limit2row_num(limit_ integer, offset_ integer DEFAULT NULL::integer, min_row_num integer DEFAULT 1) RETURNS integer
1969
    LANGUAGE sql IMMUTABLE
1970
    AS $_$
1971
SELECT COALESCE(util.offset2row_num($2, $3) + $1 - 1, 2147483647)
1972
$_$;
1973

    
1974

    
1975
--
1976
-- Name: ltrim_nl(text); Type: FUNCTION; Schema: util; Owner: -
1977
--
1978

    
1979
CREATE FUNCTION ltrim_nl(str text) RETURNS text
1980
    LANGUAGE sql IMMUTABLE
1981
    AS $_$
1982
SELECT ltrim($1, $$
1983
$$)
1984
$_$;
1985

    
1986

    
1987
--
1988
-- Name: map_filter_insert(); Type: FUNCTION; Schema: util; Owner: -
1989
--
1990

    
1991
CREATE FUNCTION map_filter_insert() RETURNS trigger
1992
    LANGUAGE plpgsql
1993
    AS $$
1994
BEGIN
1995
	IF new."from" LIKE ':%' THEN RETURN NULL; END IF; -- exclude metadata values
1996
	RETURN new;
1997
END;
1998
$$;
1999

    
2000

    
2001
--
2002
-- Name: map_get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2003
--
2004

    
2005
CREATE FUNCTION map_get(map regclass, key text) RETURNS text
2006
    LANGUAGE plpgsql STABLE STRICT
2007
    AS $_$
2008
DECLARE
2009
    value text;
2010
BEGIN
2011
    EXECUTE $$SELECT "to" FROM $$||map||$$ WHERE "from" = $1$$
2012
        INTO value USING key;
2013
    RETURN value;
2014
END;
2015
$_$;
2016

    
2017

    
2018
--
2019
-- Name: map_nulls(text[], anyelement); Type: FUNCTION; Schema: util; Owner: -
2020
--
2021

    
2022
CREATE FUNCTION map_nulls(nulls text[], value anyelement) RETURNS anyelement
2023
    LANGUAGE sql IMMUTABLE
2024
    AS $_$
2025
SELECT util._map(util.nulls_map($1), $2)
2026
$_$;
2027

    
2028

    
2029
--
2030
-- Name: FUNCTION map_nulls(nulls text[], value anyelement); Type: COMMENT; Schema: util; Owner: -
2031
--
2032

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

    
2036
[1] inlining of function calls, which is different from constant folding
2037
[2] _map()''s profiling query
2038
SELECT util._map(''"1"=>NULL, "2"=>NULL, "3"=>NULL, *=>*'', v) FROM unnest(array_fill(1, array[100000])) f (v)
2039
and map_nulls()''s profiling query
2040
SELECT util.map_nulls(array[1, 2, 3]::text[], v) FROM unnest(array_fill(1, array[100000])) f (v)
2041
both take ~920 ms.
2042
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.
2043
';
2044

    
2045

    
2046
--
2047
-- Name: map_values(regclass); Type: FUNCTION; Schema: util; Owner: -
2048
--
2049

    
2050
CREATE FUNCTION map_values(map regclass) RETURNS SETOF text
2051
    LANGUAGE plpgsql STABLE STRICT
2052
    AS $_$
2053
BEGIN
2054
    RETURN QUERY EXECUTE $$SELECT "to" FROM $$||map;
2055
END;
2056
$_$;
2057

    
2058

    
2059
--
2060
-- Name: materialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2061
--
2062

    
2063
CREATE FUNCTION materialize_query(table_esc text, sql text) RETURNS void
2064
    LANGUAGE sql
2065
    AS $_$
2066
SELECT util.create_if_not_exists($$CREATE TABLE $$||$1||$$ AS
2067
$$||util.ltrim_nl($2));
2068
-- make sure the created table has the correct estimated row count
2069
SELECT util.analyze_($1);
2070

    
2071
SELECT util.append_comment($1, '
2072
contents generated from:
2073
'||util.ltrim_nl($2)||';
2074
');
2075
$_$;
2076

    
2077

    
2078
--
2079
-- Name: FUNCTION materialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2080
--
2081

    
2082
COMMENT ON FUNCTION materialize_query(table_esc text, sql text) IS '
2083
idempotent
2084
';
2085

    
2086

    
2087
--
2088
-- Name: materialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2089
--
2090

    
2091
CREATE FUNCTION materialize_view(table_esc text, view_ regclass) RETURNS void
2092
    LANGUAGE sql
2093
    AS $_$
2094
SELECT util.materialize_query($1, $$SELECT * FROM $$||$2)
2095
$_$;
2096

    
2097

    
2098
--
2099
-- Name: FUNCTION materialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2100
--
2101

    
2102
COMMENT ON FUNCTION materialize_view(table_esc text, view_ regclass) IS '
2103
idempotent
2104
';
2105

    
2106

    
2107
--
2108
-- Name: mk_const_col(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
2109
--
2110

    
2111
CREATE FUNCTION mk_const_col(col col_ref, value anyelement) RETURNS void
2112
    LANGUAGE sql
2113
    AS $_$
2114
SELECT util.create_if_not_exists($$
2115
ALTER TABLE $$||$1.table_||$$ ADD COLUMN $$
2116
||quote_ident($1.name)||$$ $$||pg_typeof($2)||util.type_qual($2)||$$ DEFAULT $$
2117
||quote_literal($2)||$$;
2118
COMMENT ON COLUMN $$||$1.table_||$$.$$||quote_ident($1.name)||$$ IS '
2119
constant
2120
';
2121
$$)
2122
$_$;
2123

    
2124

    
2125
--
2126
-- Name: FUNCTION mk_const_col(col col_ref, value anyelement); Type: COMMENT; Schema: util; Owner: -
2127
--
2128

    
2129
COMMENT ON FUNCTION mk_const_col(col col_ref, value anyelement) IS '
2130
idempotent
2131
';
2132

    
2133

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

    
2138
CREATE FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean DEFAULT false) RETURNS void
2139
    LANGUAGE plpgsql STRICT
2140
    AS $_$
2141
DECLARE
2142
    type regtype = util.typeof(expr, col.table_::text::regtype);
2143
    col_name_sql text = quote_ident(col.name);
2144
BEGIN
2145
    PERFORM util.create_if_not_exists((CASE WHEN overwrite THEN '' ELSE $$
2146
ALTER TABLE $$||col.table_||$$ ADD   COLUMN $$||col_name_sql||$$      $$||type||$$;$$ END)||$$
2147
ALTER TABLE $$||col.table_||$$ ALTER COLUMN $$||col_name_sql||$$ TYPE $$||type||$$ USING
2148
$$||expr||$$;
2149
$$);
2150
END;
2151
$_$;
2152

    
2153

    
2154
--
2155
-- Name: FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean); Type: COMMENT; Schema: util; Owner: -
2156
--
2157

    
2158
COMMENT ON FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean) IS '
2159
idempotent
2160
';
2161

    
2162

    
2163
--
2164
-- Name: mk_diff_query(text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
2165
--
2166

    
2167
CREATE FUNCTION mk_diff_query(left_ text, right_ text, cols text DEFAULT 'left_, right_'::text, join_cond text DEFAULT 'left_ %== right_ -- refer to EXPLAIN output for expansion of %=='::text, filter text DEFAULT 'left_ IS DISTINCT FROM right_'::text) RETURNS text
2168
    LANGUAGE sql IMMUTABLE
2169
    AS $_$
2170
SELECT
2171
$$SELECT
2172
$$||$3||$$
2173
FROM      $$||$1||$$ left_
2174
FULL JOIN $$||$2||$$ right_
2175
ON $$||$4||$$
2176
WHERE $$||$5||$$
2177
ORDER BY left_, right_
2178
$$
2179
$_$;
2180

    
2181

    
2182
--
2183
-- Name: mk_keys_func(regtype); Type: FUNCTION; Schema: util; Owner: -
2184
--
2185

    
2186
CREATE FUNCTION mk_keys_func(type regtype) RETURNS void
2187
    LANGUAGE sql
2188
    AS $_$
2189
-- keys()
2190
SELECT util.mk_keys_func($1, ARRAY(
2191
SELECT col FROM util.typed_cols($1) col
2192
WHERE (col).type != ANY('{bigint}'::regtype[]) -- not a count col
2193
));
2194

    
2195
-- values_()
2196
SELECT util.mk_keys_func($1, COALESCE(
2197
	NULLIF(ARRAY(
2198
	SELECT col FROM util.typed_cols($1) col
2199
	WHERE (col).type = ANY('{bigint}'::regtype[]) -- is a count col
2200
	), ARRAY[]::util.col_cast[])
2201
, ARRAY(SELECT util.typed_cols($1))) -- no count cols, so use all cols
2202
, 'values_');
2203
$_$;
2204

    
2205

    
2206
--
2207
-- Name: mk_keys_func(regtype, col_cast[], text); Type: FUNCTION; Schema: util; Owner: -
2208
--
2209

    
2210
CREATE FUNCTION mk_keys_func(type regtype, cols col_cast[], name text DEFAULT 'keys'::text) RETURNS void
2211
    LANGUAGE sql
2212
    AS $_$
2213
SELECT util.create_if_not_exists($$
2214
CREATE TYPE $$||util.prefixed_name($3||'_', $1)||$$ AS
2215
($$||util.mk_typed_cols_list($2)||$$);
2216
$$);
2217

    
2218
SELECT util.mk_keys_func($1, util.prefixed_name($3||'_', $1)::regtype, $3);
2219
$_$;
2220

    
2221

    
2222
--
2223
-- Name: mk_keys_func(regtype, regtype, text); Type: FUNCTION; Schema: util; Owner: -
2224
--
2225

    
2226
CREATE FUNCTION mk_keys_func(type regtype, return_type regtype, name text DEFAULT 'keys'::text) RETURNS void
2227
    LANGUAGE sql
2228
    AS $_$
2229
SELECT util.create_if_not_exists($$
2230
CREATE FUNCTION $$||util.qual_name(util.schema($1), $3)||$$(value $$
2231
||util.qual_name($1)||$$)
2232
  RETURNS $$||util.qual_name($2)||$$ AS
2233
$BODY1$
2234
SELECT ROW($$||
2235
(SELECT COALESCE(string_agg($$$1.$$||quote_ident((col).col_name), ', '), '')
2236
FROM util.typed_cols($2) col) ||$$)::$$||util.qual_name($2)||$$
2237
$BODY1$
2238
  LANGUAGE sql IMMUTABLE
2239
  COST 100;
2240
$$);
2241
$_$;
2242

    
2243

    
2244
--
2245
-- Name: mk_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2246
--
2247

    
2248
CREATE FUNCTION mk_map_table(table_ text) RETURNS void
2249
    LANGUAGE sql
2250
    AS $_$
2251
SELECT util.create_if_not_exists($$
2252
CREATE TABLE $$||$1||$$
2253
(
2254
    LIKE util.map INCLUDING ALL
2255
);
2256

    
2257
CREATE TRIGGER map_filter_insert
2258
  BEFORE INSERT
2259
  ON $$||$1||$$
2260
  FOR EACH ROW
2261
  EXECUTE PROCEDURE util.map_filter_insert();
2262
$$)
2263
$_$;
2264

    
2265

    
2266
--
2267
-- Name: mk_out_params(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2268
--
2269

    
2270
CREATE FUNCTION mk_out_params(cols col_cast[]) RETURNS text
2271
    LANGUAGE sql IMMUTABLE
2272
    AS $_$
2273
SELECT COALESCE(string_agg($$, OUT $$||(unnest).col_name||$$ $$||
2274
util.qual_name((unnest).type), ''), '')
2275
FROM unnest($1)
2276
$_$;
2277

    
2278

    
2279
--
2280
-- Name: mk_search_path(text[]); Type: FUNCTION; Schema: util; Owner: -
2281
--
2282

    
2283
CREATE FUNCTION mk_search_path(VARIADIC schemas text[]) RETURNS text
2284
    LANGUAGE sql IMMUTABLE
2285
    AS $_$
2286
SELECT string_agg(quote_ident(unnest), ', ') FROM unnest($1||'util'::text)
2287
$_$;
2288

    
2289

    
2290
--
2291
-- Name: FUNCTION mk_search_path(VARIADIC schemas text[]); Type: COMMENT; Schema: util; Owner: -
2292
--
2293

    
2294
COMMENT ON FUNCTION mk_search_path(VARIADIC schemas text[]) IS '
2295
auto-appends util to the search_path to enable use of util operators
2296
';
2297

    
2298

    
2299
--
2300
-- Name: mk_set_search_path(boolean); Type: FUNCTION; Schema: util; Owner: -
2301
--
2302

    
2303
CREATE FUNCTION mk_set_search_path(for_printing boolean DEFAULT false) RETURNS text
2304
    LANGUAGE sql IMMUTABLE
2305
    AS $_$
2306
SELECT util.mk_set_search_path(current_setting('search_path'), $1)
2307
$_$;
2308

    
2309

    
2310
--
2311
-- Name: mk_set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
2312
--
2313

    
2314
CREATE FUNCTION mk_set_search_path(search_path text, for_printing boolean DEFAULT false) RETURNS text
2315
    LANGUAGE sql IMMUTABLE
2316
    AS $_$
2317
/* debug_print_return_value() needed because this function is used with EXECUTE
2318
rather than util.eval() (in order to affect the calling function), so the
2319
search_path would not otherwise be printed */
2320
SELECT $$SET$$||util._if($2, $$ /*LOCAL*/$$::text, $$ LOCAL$$)
2321
||$$ search_path TO $$||$1
2322
$_$;
2323

    
2324

    
2325
--
2326
-- Name: mk_source_col(regclass); Type: FUNCTION; Schema: util; Owner: -
2327
--
2328

    
2329
CREATE FUNCTION mk_source_col(table_ regclass) RETURNS void
2330
    LANGUAGE sql
2331
    AS $_$
2332
SELECT util.mk_const_col(($1, 'source'), util.schema($1))
2333
$_$;
2334

    
2335

    
2336
--
2337
-- Name: FUNCTION mk_source_col(table_ regclass); Type: COMMENT; Schema: util; Owner: -
2338
--
2339

    
2340
COMMENT ON FUNCTION mk_source_col(table_ regclass) IS '
2341
idempotent
2342
';
2343

    
2344

    
2345
--
2346
-- Name: mk_subset_by_row_num_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2347
--
2348

    
2349
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass) RETURNS void
2350
    LANGUAGE plpgsql STRICT
2351
    AS $_$
2352
DECLARE
2353
	view_qual_name text = util.qual_name(view_);
2354
BEGIN
2355
	EXECUTE $$
2356
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2357
  RETURNS SETOF $$||view_||$$ AS
2358
$BODY1$
2359
SELECT * FROM $$||view_qual_name||$$
2360
ORDER BY sort_col
2361
LIMIT $1 OFFSET $2
2362
$BODY1$
2363
  LANGUAGE sql STABLE
2364
  COST 100
2365
  ROWS 1000
2366
$$;
2367
	
2368
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2369
END;
2370
$_$;
2371

    
2372

    
2373
--
2374
-- Name: mk_subset_by_row_num_func(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2375
--
2376

    
2377
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass, row_num_col text) RETURNS void
2378
    LANGUAGE plpgsql STRICT
2379
    AS $_$
2380
DECLARE
2381
	view_qual_name text = util.qual_name(view_);
2382
	row_num__min__fn text = util.esc_name__append('__row_num__min', view_qual_name);
2383
BEGIN
2384
	EXECUTE $$
2385
CREATE OR REPLACE FUNCTION $$||row_num__min__fn||$$()
2386
  RETURNS integer AS
2387
$BODY1$
2388
SELECT $$||quote_ident(row_num_col)||$$
2389
FROM $$||view_qual_name||$$
2390
ORDER BY $$||quote_ident(row_num_col)||$$ ASC
2391
LIMIT 1
2392
$BODY1$
2393
  LANGUAGE sql STABLE
2394
  COST 100;
2395
$$;
2396
	
2397
	EXECUTE $$
2398
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2399
  RETURNS SETOF $$||view_||$$ AS
2400
$BODY1$
2401
SELECT * FROM $$||view_qual_name||$$
2402
WHERE $$||quote_ident(row_num_col)||$$ BETWEEN
2403
	util.offset2row_num(    $2, $$||row_num__min__fn||$$())
2404
AND util.limit2row_num ($1, $2, $$||row_num__min__fn||$$())
2405
ORDER BY $$||quote_ident(row_num_col)||$$
2406
$BODY1$
2407
  LANGUAGE sql STABLE
2408
  COST 100
2409
  ROWS 1000
2410
$$;
2411
	
2412
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2413
END;
2414
$_$;
2415

    
2416

    
2417
--
2418
-- Name: mk_subset_by_row_num_no_sort_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2419
--
2420

    
2421
CREATE FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) RETURNS void
2422
    LANGUAGE plpgsql STRICT
2423
    AS $_$
2424
DECLARE
2425
	view_qual_name text = util.qual_name(view_);
2426
BEGIN
2427
	EXECUTE $$
2428
CREATE OR REPLACE FUNCTION $$||view_||$$(no_sort boolean, limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2429
  RETURNS SETOF $$||view_||$$
2430
  SET enable_sort TO 'off'
2431
  AS
2432
$BODY1$
2433
SELECT * FROM $$||view_qual_name||$$($2, $3)
2434
$BODY1$
2435
  LANGUAGE sql STABLE
2436
  COST 100
2437
  ROWS 1000
2438
;
2439
COMMENT ON FUNCTION $$||view_||$$(no_sort boolean, limit_ integer, offset_ integer) IS '
2440
Use this for limit values greater than ~100,000 to avoid unwanted slow sorts.
2441
If you want to run EXPLAIN and get expanded output, use the regular subset
2442
function instead. (When a config param is set on a function, EXPLAIN produces
2443
just a function scan.)
2444
';
2445
$$;
2446
END;
2447
$_$;
2448

    
2449

    
2450
--
2451
-- Name: FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass); Type: COMMENT; Schema: util; Owner: -
2452
--
2453

    
2454
COMMENT ON FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) IS '
2455
creates subset function which turns off enable_sort
2456
';
2457

    
2458

    
2459
--
2460
-- Name: mk_typed_cols_list(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2461
--
2462

    
2463
CREATE FUNCTION mk_typed_cols_list(cols col_cast[]) RETURNS text
2464
    LANGUAGE sql IMMUTABLE
2465
    AS $_$
2466
SELECT COALESCE(string_agg(quote_ident((unnest).col_name)||$$ $$||
2467
util.qual_name((unnest).type), ', '), '')
2468
FROM unnest($1)
2469
$_$;
2470

    
2471

    
2472
--
2473
-- Name: name(regclass); Type: FUNCTION; Schema: util; Owner: -
2474
--
2475

    
2476
CREATE FUNCTION name(table_ regclass) RETURNS text
2477
    LANGUAGE sql STABLE
2478
    AS $_$
2479
SELECT relname::text FROM pg_class WHERE oid = $1
2480
$_$;
2481

    
2482

    
2483
--
2484
-- Name: name(regtype); Type: FUNCTION; Schema: util; Owner: -
2485
--
2486

    
2487
CREATE FUNCTION name(type regtype) RETURNS text
2488
    LANGUAGE sql STABLE
2489
    AS $_$
2490
SELECT typname::text FROM pg_type WHERE oid = $1
2491
$_$;
2492

    
2493

    
2494
--
2495
-- Name: name_was_truncated(text, integer); Type: FUNCTION; Schema: util; Owner: -
2496
--
2497

    
2498
CREATE FUNCTION name_was_truncated(name_ text, max_prefix_len integer DEFAULT 0) RETURNS boolean
2499
    LANGUAGE sql IMMUTABLE
2500
    AS $_$
2501
SELECT octet_length($1) >= util.namedatalen() - $2
2502
$_$;
2503

    
2504

    
2505
--
2506
-- Name: namedatalen(); Type: FUNCTION; Schema: util; Owner: -
2507
--
2508

    
2509
CREATE FUNCTION namedatalen() RETURNS integer
2510
    LANGUAGE sql IMMUTABLE
2511
    AS $$
2512
SELECT octet_length(repeat('_', 1024/*>63*/)::name::text)
2513
$$;
2514

    
2515

    
2516
--
2517
-- Name: not_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2518
--
2519

    
2520
CREATE FUNCTION not_empty(value anyarray) RETURNS boolean
2521
    LANGUAGE sql IMMUTABLE
2522
    AS $_$
2523
SELECT $1 IS NOT NULL AND util.array_length($1) > 0
2524
$_$;
2525

    
2526

    
2527
--
2528
-- Name: not_null(anyelement); Type: FUNCTION; Schema: util; Owner: -
2529
--
2530

    
2531
CREATE FUNCTION not_null(value anyelement) RETURNS boolean
2532
    LANGUAGE sql IMMUTABLE
2533
    AS $_$
2534
SELECT $1 IS NOT NULL
2535
$_$;
2536

    
2537

    
2538
--
2539
-- Name: nulls_map(text[]); Type: FUNCTION; Schema: util; Owner: -
2540
--
2541

    
2542
CREATE FUNCTION nulls_map(nulls text[]) RETURNS hstore
2543
    LANGUAGE sql IMMUTABLE
2544
    AS $_$
2545
SELECT util.hstore($1, NULL) || '*=>*'
2546
$_$;
2547

    
2548

    
2549
--
2550
-- Name: FUNCTION nulls_map(nulls text[]); Type: COMMENT; Schema: util; Owner: -
2551
--
2552

    
2553
COMMENT ON FUNCTION nulls_map(nulls text[]) IS '
2554
for use with _map()
2555
';
2556

    
2557

    
2558
--
2559
-- Name: offset2row_num(integer, integer); Type: FUNCTION; Schema: util; Owner: -
2560
--
2561

    
2562
CREATE FUNCTION offset2row_num(offset_ integer, min_row_num integer DEFAULT 1) RETURNS integer
2563
    LANGUAGE sql IMMUTABLE
2564
    AS $_$
2565
SELECT $2 + COALESCE($1, 0)
2566
$_$;
2567

    
2568

    
2569
--
2570
-- Name: parent(regclass); Type: FUNCTION; Schema: util; Owner: -
2571
--
2572

    
2573
CREATE FUNCTION parent(table_ regclass) RETURNS regclass
2574
    LANGUAGE sql STABLE
2575
    AS $_$
2576
SELECT inhparent FROM pg_inherits WHERE inhrelid = $1
2577
$_$;
2578

    
2579

    
2580
--
2581
-- Name: populate_table(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2582
--
2583

    
2584
CREATE FUNCTION populate_table(table_ regclass, sql text) RETURNS void
2585
    LANGUAGE sql
2586
    AS $_$
2587
SELECT util.eval($$INSERT INTO $$||$1||$$
2588
$$||util.ltrim_nl($2));
2589
-- make sure the created table has the correct estimated row count
2590
SELECT util.analyze_($1);
2591
$_$;
2592

    
2593

    
2594
--
2595
-- Name: prefixed_name(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
2596
--
2597

    
2598
CREATE FUNCTION prefixed_name(prefix text, type anyelement) RETURNS text
2599
    LANGUAGE sql IMMUTABLE
2600
    AS $_$
2601
SELECT util.qual_name(util.schema($2), $1||util.name($2))
2602
$_$;
2603

    
2604

    
2605
--
2606
-- Name: prepend_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2607
--
2608

    
2609
CREATE FUNCTION prepend_comment(table_ regclass, comment text) RETURNS void
2610
    LANGUAGE sql
2611
    AS $_$
2612
SELECT util.set_comment($1, concat($2, util.comment($1)))
2613
$_$;
2614

    
2615

    
2616
--
2617
-- Name: FUNCTION prepend_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
2618
--
2619

    
2620
COMMENT ON FUNCTION prepend_comment(table_ regclass, comment text) IS '
2621
comment: must start and end with a newline
2622
';
2623

    
2624

    
2625
--
2626
-- Name: qual_name(text[]); Type: FUNCTION; Schema: util; Owner: -
2627
--
2628

    
2629
CREATE FUNCTION qual_name(VARIADIC elems text[]) RETURNS text
2630
    LANGUAGE sql IMMUTABLE
2631
    AS $_$
2632
SELECT string_agg(quote_ident(unnest), '.') FROM unnest($1)
2633
$_$;
2634

    
2635

    
2636
--
2637
-- Name: qual_name(regclass); Type: FUNCTION; Schema: util; Owner: -
2638
--
2639

    
2640
CREATE FUNCTION qual_name(table_ regclass) RETURNS text
2641
    LANGUAGE sql STABLE
2642
    SET search_path TO pg_temp
2643
    AS $_$
2644
SELECT $1::text
2645
$_$;
2646

    
2647

    
2648
--
2649
-- Name: qual_name(regtype); Type: FUNCTION; Schema: util; Owner: -
2650
--
2651

    
2652
CREATE FUNCTION qual_name(type regtype) RETURNS text
2653
    LANGUAGE sql STABLE
2654
    SET search_path TO pg_temp
2655
    AS $_$
2656
SELECT $1::text
2657
$_$;
2658

    
2659

    
2660
--
2661
-- Name: FUNCTION qual_name(type regtype); Type: COMMENT; Schema: util; Owner: -
2662
--
2663

    
2664
COMMENT ON FUNCTION qual_name(type regtype) IS '
2665
a type''s schema-qualified name
2666
';
2667

    
2668

    
2669
--
2670
-- Name: qual_name(unknown); Type: FUNCTION; Schema: util; Owner: -
2671
--
2672

    
2673
CREATE FUNCTION qual_name(type unknown) RETURNS text
2674
    LANGUAGE sql STABLE
2675
    AS $_$
2676
SELECT util.qual_name($1::text::regtype)
2677
$_$;
2678

    
2679

    
2680
--
2681
-- Name: quote_func_call(regprocedure, text[]); Type: FUNCTION; Schema: util; Owner: -
2682
--
2683

    
2684
CREATE FUNCTION quote_func_call(func regprocedure, VARIADIC args_esc text[]) RETURNS text
2685
    LANGUAGE sql IMMUTABLE
2686
    AS $_$
2687
SELECT util.quote_func_call($1::regproc::text, VARIADIC $2)
2688
$_$;
2689

    
2690

    
2691
--
2692
-- Name: quote_func_call(text, text[]); Type: FUNCTION; Schema: util; Owner: -
2693
--
2694

    
2695
CREATE FUNCTION quote_func_call(func_esc text, VARIADIC args_esc text[]) RETURNS text
2696
    LANGUAGE sql IMMUTABLE
2697
    AS $_$
2698
SELECT $1||'('||concat_ws(', ', VARIADIC $2)||')'
2699
$_$;
2700

    
2701

    
2702
--
2703
-- Name: quote_typed(anyelement); Type: FUNCTION; Schema: util; Owner: -
2704
--
2705

    
2706
CREATE FUNCTION quote_typed(value anyelement) RETURNS text
2707
    LANGUAGE sql IMMUTABLE
2708
    AS $_$
2709
SELECT quote_nullable($1)||$$::$$||util.qual_name(pg_typeof($1))
2710
$_$;
2711

    
2712

    
2713
--
2714
-- Name: raise(text, text); Type: FUNCTION; Schema: util; Owner: -
2715
--
2716

    
2717
CREATE FUNCTION raise(type text, msg text) RETURNS void
2718
    LANGUAGE sql IMMUTABLE
2719
    AS $_X$
2720
SELECT util.eval($$
2721
CREATE OR REPLACE FUNCTION pg_temp.__raise()
2722
  RETURNS void AS
2723
-- $__BODY1$ in case msg contains $BODY1$ (in SQL)
2724
$__BODY1$
2725
BEGIN
2726
	RAISE $$||$1||$$ USING MESSAGE = $$||quote_nullable($2)||$$;
2727
END;
2728
$__BODY1$
2729
  LANGUAGE plpgsql IMMUTABLE
2730
  COST 100;
2731
$$, verbose_ := false);
2732

    
2733
SELECT util.eval($$SELECT pg_temp.__raise()$$, verbose_ := false);
2734
$_X$;
2735

    
2736

    
2737
--
2738
-- Name: FUNCTION raise(type text, msg text); Type: COMMENT; Schema: util; Owner: -
2739
--
2740

    
2741
COMMENT ON FUNCTION raise(type text, msg text) IS '
2742
type: a log level from
2743
http://www.postgresql.org/docs/9.3/static/plpgsql-errors-and-messages.html
2744
or a condition name from
2745
http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
2746
';
2747

    
2748

    
2749
--
2750
-- Name: raise_error_warning(text); Type: FUNCTION; Schema: util; Owner: -
2751
--
2752

    
2753
CREATE FUNCTION raise_error_warning(msg text) RETURNS void
2754
    LANGUAGE sql IMMUTABLE
2755
    AS $_$
2756
SELECT util.raise('WARNING', 'ERROR:  '||$1)
2757
$_$;
2758

    
2759

    
2760
--
2761
-- Name: raise_undefined_column(col_ref); Type: FUNCTION; Schema: util; Owner: -
2762
--
2763

    
2764
CREATE FUNCTION raise_undefined_column(col col_ref) RETURNS text
2765
    LANGUAGE plpgsql IMMUTABLE STRICT
2766
    AS $$
2767
BEGIN
2768
	RAISE undefined_column USING MESSAGE = concat('undefined column: ', col.name);
2769
END;
2770
$$;
2771

    
2772

    
2773
--
2774
-- Name: regexp_matches_group(text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2775
--
2776

    
2777
CREATE FUNCTION regexp_matches_group(str text, re text, group_ integer DEFAULT 1) RETURNS SETOF text
2778
    LANGUAGE sql IMMUTABLE
2779
    AS $_$
2780
SELECT regexp_matches[$3] FROM regexp_matches($1, $2, 'g')
2781
$_$;
2782

    
2783

    
2784
--
2785
-- Name: regexp_quote(text); Type: FUNCTION; Schema: util; Owner: -
2786
--
2787

    
2788
CREATE FUNCTION regexp_quote(str text) RETURNS text
2789
    LANGUAGE sql IMMUTABLE
2790
    AS $_$
2791
SELECT regexp_replace($1, '\W', /*\char*/'\\\&', 'g')
2792
$_$;
2793

    
2794

    
2795
--
2796
-- Name: regprocedure(text); Type: FUNCTION; Schema: util; Owner: -
2797
--
2798

    
2799
CREATE FUNCTION regprocedure(func text) RETURNS regprocedure
2800
    LANGUAGE sql IMMUTABLE
2801
    AS $_$
2802
SELECT (CASE WHEN right($1, 1) = ')'
2803
THEN $1::regprocedure ELSE $1::regproc::regprocedure END)
2804
$_$;
2805

    
2806

    
2807
--
2808
-- Name: relation_type(regclass); Type: FUNCTION; Schema: util; Owner: -
2809
--
2810

    
2811
CREATE FUNCTION relation_type(relation regclass) RETURNS text
2812
    LANGUAGE sql STABLE
2813
    AS $_$
2814
SELECT util.relation_type(util.relation_type_char($1))
2815
$_$;
2816

    
2817

    
2818
--
2819
-- Name: relation_type("char"); Type: FUNCTION; Schema: util; Owner: -
2820
--
2821

    
2822
CREATE FUNCTION relation_type(relation_type_char "char") RETURNS text
2823
    LANGUAGE sql IMMUTABLE
2824
    AS $_$
2825
SELECT 'c=>TYPE, r=>TABLE, v=>VIEW'::hstore -> $1
2826
$_$;
2827

    
2828

    
2829
--
2830
-- Name: relation_type(regtype); Type: FUNCTION; Schema: util; Owner: -
2831
--
2832

    
2833
CREATE FUNCTION relation_type(type regtype) RETURNS text
2834
    LANGUAGE sql IMMUTABLE
2835
    AS $$
2836
SELECT 'TYPE'::text
2837
$$;
2838

    
2839

    
2840
--
2841
-- Name: relation_type_char(regclass); Type: FUNCTION; Schema: util; Owner: -
2842
--
2843

    
2844
CREATE FUNCTION relation_type_char(relation regclass) RETURNS "char"
2845
    LANGUAGE sql STABLE
2846
    AS $_$
2847
SELECT relkind FROM pg_class WHERE oid = $1
2848
$_$;
2849

    
2850

    
2851
--
2852
-- Name: remake_diff_table(text, regclass, regclass, text); Type: FUNCTION; Schema: util; Owner: -
2853
--
2854

    
2855
CREATE FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) RETURNS void
2856
    LANGUAGE sql
2857
    AS $_$
2858
/* can't have in_table/out_table inherit from *each other*, because inheritance
2859
also causes the rows of the parent table to be included in the child table.
2860
instead, they need to inherit from a common, empty table. */
2861
SELECT util.create_if_not_exists($$SELECT $$||util.quote_func_call(
2862
'util.copy_struct', util.quote_typed($2), util.quote_typed($4)));
2863
SELECT util.inherit($2, $4);
2864
SELECT util.inherit($3, $4);
2865

    
2866
SELECT util.rematerialize_query($1, $$
2867
SELECT * FROM util.diff(
2868
  $$||util.quote_typed($2)||$$
2869
, $$||util.quote_typed($3)||$$
2870
, NULL::$$||$4||$$)
2871
$$);
2872

    
2873
/* the table unfortunately cannot be *materialized* in human-readable form,
2874
because this would create column name collisions between the two sides */
2875
SELECT util.prepend_comment($1, '
2876
to view this table in human-readable form (with each side''s tuple column
2877
expanded to its component fields):
2878
SELECT (left_).*, ('||util.schema($4::regclass)||'.values_(right_)).* FROM '||$1||';
2879
');
2880
$_$;
2881

    
2882

    
2883
--
2884
-- Name: FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text); Type: COMMENT; Schema: util; Owner: -
2885
--
2886

    
2887
COMMENT ON FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) IS '
2888
type_table (*required*): table to create as the shared base type
2889
';
2890

    
2891

    
2892
--
2893
-- Name: rematerialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2894
--
2895

    
2896
CREATE FUNCTION rematerialize_query(table_esc text, sql text) RETURNS void
2897
    LANGUAGE sql
2898
    AS $_$
2899
SELECT util.drop_table($1);
2900
SELECT util.materialize_query($1, $2);
2901
$_$;
2902

    
2903

    
2904
--
2905
-- Name: FUNCTION rematerialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2906
--
2907

    
2908
COMMENT ON FUNCTION rematerialize_query(table_esc text, sql text) IS '
2909
idempotent, but repeats action each time
2910
';
2911

    
2912

    
2913
--
2914
-- Name: rematerialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2915
--
2916

    
2917
CREATE FUNCTION rematerialize_view(table_esc text, view_ regclass) RETURNS void
2918
    LANGUAGE sql
2919
    AS $_$
2920
SELECT util.drop_table($1);
2921
SELECT util.materialize_view($1, $2);
2922
$_$;
2923

    
2924

    
2925
--
2926
-- Name: FUNCTION rematerialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2927
--
2928

    
2929
COMMENT ON FUNCTION rematerialize_view(table_esc text, view_ regclass) IS '
2930
idempotent, but repeats action each time
2931
';
2932

    
2933

    
2934
--
2935
-- Name: rename_cols(regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
2936
--
2937

    
2938
CREATE FUNCTION rename_cols(table_ regclass, renames anyelement) RETURNS void
2939
    LANGUAGE sql
2940
    AS $_$
2941
SELECT util.try_create($$ALTER TABLE $$||$1||$$ RENAME $$
2942
||quote_ident(name)||$$ TO $$||quote_ident($2 -> name))
2943
FROM util.col_names($1::text::regtype) f (name);
2944
SELECT NULL::void; -- don't fold away functions called in previous query
2945
$_$;
2946

    
2947

    
2948
--
2949
-- Name: FUNCTION rename_cols(table_ regclass, renames anyelement); Type: COMMENT; Schema: util; Owner: -
2950
--
2951

    
2952
COMMENT ON FUNCTION rename_cols(table_ regclass, renames anyelement) IS '
2953
idempotent
2954
';
2955

    
2956

    
2957
--
2958
-- Name: rename_relation(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2959
--
2960

    
2961
CREATE FUNCTION rename_relation(from_ regclass, to_ text) RETURNS void
2962
    LANGUAGE sql
2963
    AS $_$
2964
/* use util.qual_name() instead of ::text so that the schema qualifier is always
2965
included in the debug SQL */
2966
SELECT util.rename_relation(util.qual_name($1), $2)
2967
$_$;
2968

    
2969

    
2970
--
2971
-- Name: rename_relation(text, text); Type: FUNCTION; Schema: util; Owner: -
2972
--
2973

    
2974
CREATE FUNCTION rename_relation(from_esc text, to_name text) RETURNS void
2975
    LANGUAGE sql
2976
    AS $_$
2977
/* 'ALTER TABLE can be used with views too'
2978
(http://www.postgresql.org/docs/9.3/static/sql-alterview.html) */
2979
SELECT util.eval($$ALTER TABLE IF EXISTS $$||$1||$$ RENAME TO $$
2980
||quote_ident($2))
2981
$_$;
2982

    
2983

    
2984
--
2985
-- Name: FUNCTION rename_relation(from_esc text, to_name text); Type: COMMENT; Schema: util; Owner: -
2986
--
2987

    
2988
COMMENT ON FUNCTION rename_relation(from_esc text, to_name text) IS '
2989
idempotent
2990
';
2991

    
2992

    
2993
--
2994
-- Name: replace_suffix(text, text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2995
--
2996

    
2997
CREATE FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer DEFAULT 0) RETURNS text
2998
    LANGUAGE sql IMMUTABLE
2999
    AS $_$
3000
SELECT regexp_replace($1, util.truncated_prefixed_name_regexp($2, $4), '\1'||$3)
3001
$_$;
3002

    
3003

    
3004
--
3005
-- Name: FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer); Type: COMMENT; Schema: util; Owner: -
3006
--
3007

    
3008
COMMENT ON FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer) IS '
3009
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 
3010
';
3011

    
3012

    
3013
--
3014
-- Name: reset_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3015
--
3016

    
3017
CREATE FUNCTION reset_col_names(table_ regclass, names regclass) RETURNS void
3018
    LANGUAGE sql
3019
    AS $_$
3020
SELECT util.eval($$DELETE FROM $$||$2||$$ WHERE "from" LIKE ':%'$$);
3021
SELECT util.mk_derived_col(($2, 'to'), $$"from"$$, overwrite := true);
3022
SELECT util.set_col_names($1, $2);
3023
$_$;
3024

    
3025

    
3026
--
3027
-- Name: FUNCTION reset_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3028
--
3029

    
3030
COMMENT ON FUNCTION reset_col_names(table_ regclass, names regclass) IS '
3031
idempotent.
3032
alters the names table, so it will need to be repopulated after running this function.
3033
';
3034

    
3035

    
3036
--
3037
-- Name: reset_map_table(text); Type: FUNCTION; Schema: util; Owner: -
3038
--
3039

    
3040
CREATE FUNCTION reset_map_table(table_ text) RETURNS void
3041
    LANGUAGE sql
3042
    AS $_$
3043
SELECT util.drop_table($1);
3044
SELECT util.mk_map_table($1);
3045
$_$;
3046

    
3047

    
3048
--
3049
-- Name: rtrim_n(text, integer); Type: FUNCTION; Schema: util; Owner: -
3050
--
3051

    
3052
CREATE FUNCTION rtrim_n(str text, count integer) RETURNS text
3053
    LANGUAGE sql IMMUTABLE
3054
    AS $_$
3055
SELECT (CASE WHEN $2 <= 0 THEN $1 ELSE left($1, -$2) END)
3056
$_$;
3057

    
3058

    
3059
--
3060
-- Name: runnable_sql(text); Type: FUNCTION; Schema: util; Owner: -
3061
--
3062

    
3063
CREATE FUNCTION runnable_sql(sql text) RETURNS text
3064
    LANGUAGE sql IMMUTABLE
3065
    AS $_$
3066
SELECT (CASE WHEN util.is_set_stmt($1) THEN ''
3067
ELSE util.mk_set_search_path(for_printing := true)||$$;
3068
$$ END)||$1
3069
$_$;
3070

    
3071

    
3072
--
3073
-- Name: save_drop_view(text); Type: FUNCTION; Schema: util; Owner: -
3074
--
3075

    
3076
CREATE FUNCTION save_drop_view(view_ text) RETURNS text
3077
    LANGUAGE plpgsql STRICT
3078
    AS $_$
3079
DECLARE
3080
	result text = NULL;
3081
BEGIN
3082
	BEGIN
3083
		result = util.show_create_view(view_);
3084
		PERFORM util.eval($$DROP VIEW $$||view_);
3085
	EXCEPTION
3086
		WHEN undefined_table THEN NULL;
3087
	END;
3088
	RETURN result;
3089
END;
3090
$_$;
3091

    
3092

    
3093
--
3094
-- Name: save_drop_views(text[]); Type: FUNCTION; Schema: util; Owner: -
3095
--
3096

    
3097
CREATE FUNCTION save_drop_views(views text[]) RETURNS text
3098
    LANGUAGE sql
3099
    AS $_$
3100
SELECT string_agg(util.save_drop_view(unnest), '') FROM unnest($1)
3101
$_$;
3102

    
3103

    
3104
--
3105
-- Name: schema(oid); Type: FUNCTION; Schema: util; Owner: -
3106
--
3107

    
3108
CREATE FUNCTION schema(pg_namespace_oid oid) RETURNS text
3109
    LANGUAGE sql STABLE
3110
    AS $_$
3111
SELECT nspname::text FROM pg_namespace WHERE pg_namespace.oid = $1
3112
$_$;
3113

    
3114

    
3115
--
3116
-- Name: schema(regclass); Type: FUNCTION; Schema: util; Owner: -
3117
--
3118

    
3119
CREATE FUNCTION schema(table_ regclass) RETURNS text
3120
    LANGUAGE sql STABLE
3121
    AS $_$
3122
SELECT util.schema(relnamespace) FROM pg_class WHERE oid = $1
3123
$_$;
3124

    
3125

    
3126
--
3127
-- Name: schema(regtype); Type: FUNCTION; Schema: util; Owner: -
3128
--
3129

    
3130
CREATE FUNCTION schema(type regtype) RETURNS text
3131
    LANGUAGE sql STABLE
3132
    AS $_$
3133
SELECT util.schema(typnamespace) FROM pg_type WHERE oid = $1
3134
$_$;
3135

    
3136

    
3137
--
3138
-- Name: schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3139
--
3140

    
3141
CREATE FUNCTION schema(type_null anyelement) RETURNS text
3142
    LANGUAGE sql STABLE
3143
    AS $_$
3144
SELECT util.schema(pg_typeof($1))
3145
$_$;
3146

    
3147

    
3148
--
3149
-- Name: schema_bundle_get_schemas(text); Type: FUNCTION; Schema: util; Owner: -
3150
--
3151

    
3152
CREATE FUNCTION schema_bundle_get_schemas(schema_bundle text) RETURNS SETOF text
3153
    LANGUAGE sql STABLE
3154
    AS $_$
3155
SELECT nspname::text FROM pg_namespace WHERE nspname ~ ('^'||$1||'(?=\y|_)')
3156
$_$;
3157

    
3158

    
3159
--
3160
-- Name: FUNCTION schema_bundle_get_schemas(schema_bundle text); Type: COMMENT; Schema: util; Owner: -
3161
--
3162

    
3163
COMMENT ON FUNCTION schema_bundle_get_schemas(schema_bundle text) IS '
3164
a schema bundle is a group of schemas with a common prefix
3165
';
3166

    
3167

    
3168
--
3169
-- Name: schema_bundle_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3170
--
3171

    
3172
CREATE FUNCTION schema_bundle_rename(old text, new text) RETURNS void
3173
    LANGUAGE sql
3174
    AS $_$
3175
SELECT util.schema_rename(old_schema,
3176
	overlay(old_schema placing new from 1 for length(old))) -- replace prefix
3177
FROM util.schema_bundle_get_schemas($1) f (old_schema);
3178
SELECT NULL::void; -- don't fold away functions called in previous query
3179
$_$;
3180

    
3181

    
3182
--
3183
-- Name: schema_bundle_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3184
--
3185

    
3186
CREATE FUNCTION schema_bundle_replace(replace text, with_ text) RETURNS void
3187
    LANGUAGE plpgsql
3188
    AS $$
3189
BEGIN
3190
	-- don't schema_bundle_rm() the schema_bundle to keep!
3191
	IF replace = with_ THEN RETURN; END IF;
3192
	
3193
	PERFORM util.schema_bundle_rm(replace);
3194
	PERFORM util.schema_bundle_rename(with_, replace);
3195
END;
3196
$$;
3197

    
3198

    
3199
--
3200
-- Name: schema_bundle_rm(text); Type: FUNCTION; Schema: util; Owner: -
3201
--
3202

    
3203
CREATE FUNCTION schema_bundle_rm(schema_bundle text) RETURNS void
3204
    LANGUAGE sql
3205
    AS $_$
3206
SELECT util.schema_rm(schema)
3207
FROM util.schema_bundle_get_schemas($1) f (schema);
3208
SELECT NULL::void; -- don't fold away functions called in previous query
3209
$_$;
3210

    
3211

    
3212
--
3213
-- Name: schema_esc(anyelement); Type: FUNCTION; Schema: util; Owner: -
3214
--
3215

    
3216
CREATE FUNCTION schema_esc(type_null anyelement) RETURNS text
3217
    LANGUAGE sql STABLE
3218
    AS $_$
3219
SELECT quote_ident(util.schema($1))
3220
$_$;
3221

    
3222

    
3223
--
3224
-- Name: schema_matches(text, text); Type: FUNCTION; Schema: util; Owner: -
3225
--
3226

    
3227
CREATE FUNCTION schema_matches(schema text, schema_regexp text) RETURNS boolean
3228
    LANGUAGE sql IMMUTABLE
3229
    AS $_$
3230
SELECT $1 ~ $2 AND /*in userspace*/$1 !~ '^(?:information_schema|pg_.*)$'
3231
$_$;
3232

    
3233

    
3234
--
3235
-- Name: schema_oid(text); Type: FUNCTION; Schema: util; Owner: -
3236
--
3237

    
3238
CREATE FUNCTION schema_oid(schema text) RETURNS oid
3239
    LANGUAGE sql STABLE
3240
    AS $_$
3241
SELECT oid FROM pg_namespace WHERE nspname = $1
3242
$_$;
3243

    
3244

    
3245
--
3246
-- Name: schema_regexp(regclass); Type: FUNCTION; Schema: util; Owner: -
3247
--
3248

    
3249
CREATE FUNCTION schema_regexp(relation regclass) RETURNS text
3250
    LANGUAGE sql IMMUTABLE
3251
    AS $_$
3252
SELECT util.schema_regexp(schema_anchor := $1)
3253
$_$;
3254

    
3255

    
3256
--
3257
-- Name: schema_regexp(anyelement); Type: FUNCTION; Schema: util; Owner: -
3258
--
3259

    
3260
CREATE FUNCTION schema_regexp(schema_anchor anyelement) RETURNS text
3261
    LANGUAGE sql IMMUTABLE
3262
    AS $_$
3263
SELECT util.str_equality_regexp(util.schema($1))
3264
$_$;
3265

    
3266

    
3267
--
3268
-- Name: schema_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3269
--
3270

    
3271
CREATE FUNCTION schema_rename(old text, new text) RETURNS void
3272
    LANGUAGE sql
3273
    AS $_$
3274
SELECT util.eval($$ALTER SCHEMA $$||quote_ident($1)||$$ RENAME TO $$||quote_ident($2));
3275
$_$;
3276

    
3277

    
3278
--
3279
-- Name: schema_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3280
--
3281

    
3282
CREATE FUNCTION schema_replace(replace text, with_ text) RETURNS void
3283
    LANGUAGE plpgsql
3284
    AS $$
3285
BEGIN
3286
	-- don't schema_rm() the schema to keep!
3287
	IF replace = with_ THEN RETURN; END IF;
3288
	
3289
	PERFORM util.schema_rm(replace);
3290
	PERFORM util.schema_rename(with_, replace);
3291
END;
3292
$$;
3293

    
3294

    
3295
--
3296
-- Name: schema_rm(text); Type: FUNCTION; Schema: util; Owner: -
3297
--
3298

    
3299
CREATE FUNCTION schema_rm(schema text) RETURNS void
3300
    LANGUAGE sql
3301
    AS $_$
3302
SELECT util.eval($$DROP SCHEMA IF EXISTS $$||quote_ident($1)||$$ CASCADE$$);
3303
$_$;
3304

    
3305

    
3306
--
3307
-- Name: search_path_append(text); Type: FUNCTION; Schema: util; Owner: -
3308
--
3309

    
3310
CREATE FUNCTION search_path_append(schemas text) RETURNS void
3311
    LANGUAGE sql
3312
    AS $_$
3313
SELECT util.eval(
3314
$$SET search_path TO $$||current_setting('search_path')||$$, $$||$1);
3315
$_$;
3316

    
3317

    
3318
--
3319
-- Name: set_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3320
--
3321

    
3322
CREATE FUNCTION set_col_names(table_ regclass, names regclass) RETURNS void
3323
    LANGUAGE plpgsql STRICT
3324
    AS $_$
3325
DECLARE
3326
    old text[] = ARRAY(SELECT util.col_names(table_));
3327
    new text[] = ARRAY(SELECT util.map_values(names));
3328
BEGIN
3329
    old = old[1:array_length(new, 1)]; -- truncate to same length
3330
    PERFORM util.eval($$ALTER TABLE $$||$1||$$ RENAME $$||quote_ident(key)
3331
||$$ TO $$||quote_ident(value))
3332
    FROM each(hstore(old, new))
3333
    WHERE value != key -- not same name
3334
    ;
3335
END;
3336
$_$;
3337

    
3338

    
3339
--
3340
-- Name: FUNCTION set_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3341
--
3342

    
3343
COMMENT ON FUNCTION set_col_names(table_ regclass, names regclass) IS '
3344
idempotent
3345
';
3346

    
3347

    
3348
--
3349
-- Name: set_col_names_with_metadata(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3350
--
3351

    
3352
CREATE FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) RETURNS void
3353
    LANGUAGE plpgsql STRICT
3354
    AS $_$
3355
DECLARE
3356
	row_ util.map;
3357
BEGIN
3358
	-- rename any metadata cols rather than re-adding them with new names
3359
	BEGIN
3360
		PERFORM util.set_col_names(table_, names);
3361
	EXCEPTION
3362
		WHEN array_subscript_error THEN -- selective suppress
3363
			IF SQLERRM LIKE 'arrays must have same bounds' THEN NULL;
3364
				-- metadata cols not yet added
3365
			ELSE RAISE;
3366
			END IF;
3367
	END;
3368
	
3369
	FOR row_ IN EXECUTE $$SELECT * FROM $$||names||$$ WHERE "from" LIKE ':%'$$
3370
	LOOP
3371
		PERFORM util.mk_const_col((table_, row_."to"),
3372
			substring(row_."from" from 2));
3373
	END LOOP;
3374
	
3375
	PERFORM util.set_col_names(table_, names);
3376
END;
3377
$_$;
3378

    
3379

    
3380
--
3381
-- Name: FUNCTION set_col_names_with_metadata(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3382
--
3383

    
3384
COMMENT ON FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) IS '
3385
idempotent.
3386
the metadata mappings must be *last* in the names table.
3387
';
3388

    
3389

    
3390
--
3391
-- Name: set_col_types(regclass, col_cast[]); Type: FUNCTION; Schema: util; Owner: -
3392
--
3393

    
3394
CREATE FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) RETURNS void
3395
    LANGUAGE plpgsql STRICT
3396
    AS $_$
3397
DECLARE
3398
    sql text = $$ALTER TABLE $$||table_||$$
3399
$$||NULLIF(array_to_string(ARRAY(
3400
    SELECT
3401
    $$ALTER COLUMN $$||col_name_sql||$$ TYPE $$||target_type
3402
    ||$$ USING $$||col_name_sql||$$::$$||target_type
3403
    FROM
3404
    (
3405
        SELECT
3406
          quote_ident(col_name) AS col_name_sql
3407
        , util.col_type((table_, col_name)) AS curr_type
3408
        , type AS target_type
3409
        FROM unnest(col_casts)
3410
    ) s
3411
    WHERE curr_type != target_type
3412
), '
3413
, '), '');
3414
BEGIN
3415
    PERFORM util.debug_print_sql(sql);
3416
    EXECUTE COALESCE(sql, '');
3417
END;
3418
$_$;
3419

    
3420

    
3421
--
3422
-- Name: FUNCTION set_col_types(table_ regclass, col_casts col_cast[]); Type: COMMENT; Schema: util; Owner: -
3423
--
3424

    
3425
COMMENT ON FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) IS '
3426
idempotent
3427
';
3428

    
3429

    
3430
--
3431
-- Name: set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3432
--
3433

    
3434
CREATE FUNCTION set_comment(table_ regclass, comment text) RETURNS void
3435
    LANGUAGE sql
3436
    AS $_$
3437
SELECT util.eval($$COMMENT ON TABLE $$||$1||$$ IS $$||quote_nullable($2))
3438
$_$;
3439

    
3440

    
3441
--
3442
-- Name: set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
3443
--
3444

    
3445
CREATE FUNCTION set_search_path(search_path text, for_session boolean DEFAULT false) RETURNS void
3446
    LANGUAGE sql
3447
    AS $_$
3448
SELECT util.eval(util.mk_set_search_path($1, $2))
3449
$_$;
3450

    
3451

    
3452
--
3453
-- Name: show_create_view(regclass); Type: FUNCTION; Schema: util; Owner: -
3454
--
3455

    
3456
CREATE FUNCTION show_create_view(view_ regclass) RETURNS text
3457
    LANGUAGE sql STABLE
3458
    AS $_$
3459
SELECT $$CREATE OR REPLACE VIEW $$||$1||$$ AS $$||pg_get_viewdef($1)||$$;
3460
$$||util.show_grants_for($1)
3461
$_$;
3462

    
3463

    
3464
--
3465
-- Name: show_grants_for(regclass); Type: FUNCTION; Schema: util; Owner: -
3466
--
3467

    
3468
CREATE FUNCTION show_grants_for(table_ regclass) RETURNS text
3469
    LANGUAGE sql STABLE
3470
    AS $_$
3471
SELECT string_agg(cmd, '')
3472
FROM
3473
(
3474
	SELECT (CASE WHEN has_table_privilege(user_, $1, 'SELECT') THEN
3475
$$GRANT SELECT ON TABLE $$||$1||$$ TO $$||quote_ident(user_)||$$;
3476
$$ ELSE '' END) AS cmd
3477
	FROM util.grants_users() f (user_)
3478
) s
3479
$_$;
3480

    
3481

    
3482
--
3483
-- Name: show_relations_like(text, text, character[]); Type: FUNCTION; Schema: util; Owner: -
3484
--
3485

    
3486
CREATE FUNCTION show_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, types character[] DEFAULT ARRAY['r'::text, 'v'::text]) RETURNS SETOF regclass
3487
    LANGUAGE sql STABLE
3488
    AS $_$
3489
SELECT oid FROM pg_class
3490
WHERE relkind = ANY($3) AND relname ~ $1
3491
AND util.schema_matches(util.schema(relnamespace), $2)
3492
ORDER BY relname
3493
$_$;
3494

    
3495

    
3496
--
3497
-- Name: show_types_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3498
--
3499

    
3500
CREATE FUNCTION show_types_like(name_regexp text DEFAULT ''::text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regtype
3501
    LANGUAGE sql STABLE
3502
    AS $_$
3503
SELECT oid
3504
FROM pg_type
3505
WHERE typname ~ $1 AND util.schema_matches(util.schema(typnamespace), $2)
3506
ORDER BY typname
3507
$_$;
3508

    
3509

    
3510
--
3511
-- Name: show_views_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3512
--
3513

    
3514
CREATE FUNCTION show_views_like(name_regexp text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regclass
3515
    LANGUAGE sql STABLE
3516
    AS $_$
3517
SELECT * FROM util.show_relations_like($1, $2, ARRAY['v'])
3518
$_$;
3519

    
3520

    
3521
--
3522
-- Name: str_equality_regexp(text); Type: FUNCTION; Schema: util; Owner: -
3523
--
3524

    
3525
CREATE FUNCTION str_equality_regexp(literal text) RETURNS text
3526
    LANGUAGE sql IMMUTABLE
3527
    AS $_$
3528
SELECT '^'||util.regexp_quote($1)||'$'
3529
$_$;
3530

    
3531

    
3532
--
3533
-- Name: table2hstore(regclass); Type: FUNCTION; Schema: util; Owner: -
3534
--
3535

    
3536
CREATE FUNCTION table2hstore(table_ regclass) RETURNS hstore
3537
    LANGUAGE plpgsql STABLE STRICT
3538
    AS $_$
3539
DECLARE
3540
    hstore hstore;
3541
BEGIN
3542
    EXECUTE $$SELECT hstore(ARRAY(SELECT unnest(ARRAY["from", "to"]) FROM $$||
3543
        table_||$$))$$ INTO STRICT hstore;
3544
    RETURN hstore;
3545
END;
3546
$_$;
3547

    
3548

    
3549
--
3550
-- Name: table_flag__get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3551
--
3552

    
3553
CREATE FUNCTION table_flag__get(table_ regclass, flag text) RETURNS boolean
3554
    LANGUAGE sql STABLE
3555
    AS $_$
3556
SELECT COUNT(*) > 0 FROM pg_constraint
3557
WHERE conrelid = $1 AND contype = 'c' AND conname = $2
3558
$_$;
3559

    
3560

    
3561
--
3562
-- Name: FUNCTION table_flag__get(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3563
--
3564

    
3565
COMMENT ON FUNCTION table_flag__get(table_ regclass, flag text) IS '
3566
gets whether a status flag is set by the presence of a table constraint
3567
';
3568

    
3569

    
3570
--
3571
-- Name: table_flag__set(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3572
--
3573

    
3574
CREATE FUNCTION table_flag__set(table_ regclass, flag text) RETURNS void
3575
    LANGUAGE sql
3576
    AS $_$
3577
SELECT util.create_if_not_exists($$ALTER TABLE $$||$1||$$ ADD CONSTRAINT $$
3578
||quote_ident($2)||$$ CHECK (true)$$)
3579
$_$;
3580

    
3581

    
3582
--
3583
-- Name: FUNCTION table_flag__set(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3584
--
3585

    
3586
COMMENT ON FUNCTION table_flag__set(table_ regclass, flag text) IS '
3587
stores a status flag by the presence of a table constraint.
3588
idempotent.
3589
';
3590

    
3591

    
3592
--
3593
-- Name: table_nulls_mapped__get(regclass); Type: FUNCTION; Schema: util; Owner: -
3594
--
3595

    
3596
CREATE FUNCTION table_nulls_mapped__get(table_ regclass) RETURNS boolean
3597
    LANGUAGE sql STABLE
3598
    AS $_$
3599
SELECT util.table_flag__get($1, 'nulls_mapped')
3600
$_$;
3601

    
3602

    
3603
--
3604
-- Name: FUNCTION table_nulls_mapped__get(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3605
--
3606

    
3607
COMMENT ON FUNCTION table_nulls_mapped__get(table_ regclass) IS '
3608
gets whether a table''s NULL-equivalent strings have been replaced with NULL
3609
';
3610

    
3611

    
3612
--
3613
-- Name: table_nulls_mapped__set(regclass); Type: FUNCTION; Schema: util; Owner: -
3614
--
3615

    
3616
CREATE FUNCTION table_nulls_mapped__set(table_ regclass) RETURNS void
3617
    LANGUAGE sql
3618
    AS $_$
3619
SELECT util.table_flag__set($1, 'nulls_mapped')
3620
$_$;
3621

    
3622

    
3623
--
3624
-- Name: FUNCTION table_nulls_mapped__set(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3625
--
3626

    
3627
COMMENT ON FUNCTION table_nulls_mapped__set(table_ regclass) IS '
3628
sets that a table''s NULL-equivalent strings have been replaced with NULL.
3629
idempotent.
3630
';
3631

    
3632

    
3633
--
3634
-- Name: to_freq(regclass); Type: FUNCTION; Schema: util; Owner: -
3635
--
3636

    
3637
CREATE FUNCTION to_freq(table_ regclass) RETURNS void
3638
    LANGUAGE sql
3639
    AS $_$
3640
-- save data before truncating main table
3641
SELECT util.copy_types_and_data($1, 'pg_temp.__copy');
3642

    
3643
-- repopulate main table w/ copies column
3644
SELECT util.truncate($1);
3645
SELECT util.eval($$ALTER TABLE $$||$1||$$ ADD COLUMN copies bigint NOT NULL$$);
3646
SELECT util.populate_table($1, $$
3647
SELECT (table_).*, copies
3648
FROM (
3649
	SELECT table_, COUNT(*) AS copies
3650
	FROM pg_temp.__copy table_
3651
	GROUP BY table_
3652
) s
3653
$$);
3654

    
3655
-- delete temp table so it doesn't stay around until end of connection
3656
SELECT util.drop_table('pg_temp.__copy');
3657
$_$;
3658

    
3659

    
3660
--
3661
-- Name: to_global_col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
3662
--
3663

    
3664
CREATE FUNCTION to_global_col_names(table_ regclass) RETURNS void
3665
    LANGUAGE plpgsql STRICT
3666
    AS $_$
3667
DECLARE
3668
    row record;
3669
BEGIN
3670
    FOR row IN SELECT * FROM util.col_global_names(table_::text::regtype)
3671
    LOOP
3672
        IF row.global_name != row.name THEN
3673
            EXECUTE $$ALTER TABLE $$||table_||$$ RENAME $$
3674
                ||quote_ident(row.name)||$$ TO $$||quote_ident(row.global_name);
3675
        END IF;
3676
    END LOOP;
3677
END;
3678
$_$;
3679

    
3680

    
3681
--
3682
-- Name: FUNCTION to_global_col_names(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3683
--
3684

    
3685
COMMENT ON FUNCTION to_global_col_names(table_ regclass) IS '
3686
idempotent
3687
';
3688

    
3689

    
3690
--
3691
-- Name: trim(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3692
--
3693

    
3694
CREATE FUNCTION "trim"(table_ regclass, names regclass) RETURNS void
3695
    LANGUAGE sql
3696
    AS $_$
3697
SELECT util.drop_column(($1, col)) FROM util.added_cols($1, $2) f (col);
3698
SELECT NULL::void; -- don't fold away functions called in previous query
3699
$_$;
3700

    
3701

    
3702
--
3703
-- Name: FUNCTION "trim"(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3704
--
3705

    
3706
COMMENT ON FUNCTION "trim"(table_ regclass, names regclass) IS '
3707
trims table_ to include only columns in the original data.
3708
idempotent.
3709
';
3710

    
3711

    
3712
--
3713
-- Name: truncate(regclass); Type: FUNCTION; Schema: util; Owner: -
3714
--
3715

    
3716
CREATE FUNCTION truncate(table_ regclass) RETURNS void
3717
    LANGUAGE plpgsql STRICT
3718
    AS $_$
3719
BEGIN
3720
    EXECUTE $$TRUNCATE $$||table_||$$ CASCADE$$;
3721
END;
3722
$_$;
3723

    
3724

    
3725
--
3726
-- Name: FUNCTION truncate(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3727
--
3728

    
3729
COMMENT ON FUNCTION truncate(table_ regclass) IS '
3730
idempotent
3731
';
3732

    
3733

    
3734
--
3735
-- Name: truncated_prefixed_name_regexp(text, integer); Type: FUNCTION; Schema: util; Owner: -
3736
--
3737

    
3738
CREATE FUNCTION truncated_prefixed_name_regexp(name text, max_prefix_len integer) RETURNS text
3739
    LANGUAGE sql IMMUTABLE
3740
    AS $_$
3741
SELECT '^(.*)'||util._if(util.name_was_truncated($1, $2),
3742
util.regexp_quote(util.rtrim_n($1, $2))||'.*', util.regexp_quote($1)) ||'$'
3743
$_$;
3744

    
3745

    
3746
--
3747
-- Name: try_create(text); Type: FUNCTION; Schema: util; Owner: -
3748
--
3749

    
3750
CREATE FUNCTION try_create(sql text) RETURNS void
3751
    LANGUAGE plpgsql STRICT
3752
    AS $$
3753
BEGIN
3754
	PERFORM util.eval(sql);
3755
EXCEPTION
3756
	/* trying to add NOT NULL column to parent table, which cascades to child
3757
	table whose values for the new column will be NULL */
3758
	WHEN not_null_violation THEN NULL;
3759
	WHEN wrong_object_type THEN NULL; -- trying to alter a view's columns
3760
	WHEN undefined_column THEN NULL;
3761
	WHEN duplicate_column THEN NULL;
3762
END;
3763
$$;
3764

    
3765

    
3766
--
3767
-- Name: FUNCTION try_create(sql text); Type: COMMENT; Schema: util; Owner: -
3768
--
3769

    
3770
COMMENT ON FUNCTION try_create(sql text) IS '
3771
idempotent
3772
';
3773

    
3774

    
3775
--
3776
-- Name: try_mk_derived_col(col_ref, text); Type: FUNCTION; Schema: util; Owner: -
3777
--
3778

    
3779
CREATE FUNCTION try_mk_derived_col(col col_ref, expr text) RETURNS void
3780
    LANGUAGE sql
3781
    AS $_$
3782
SELECT util.try_create($$SELECT util.mk_derived_col($$||quote_literal($1)||$$, $$||quote_literal($2)||$$)$$)
3783
$_$;
3784

    
3785

    
3786
--
3787
-- Name: FUNCTION try_mk_derived_col(col col_ref, expr text); Type: COMMENT; Schema: util; Owner: -
3788
--
3789

    
3790
COMMENT ON FUNCTION try_mk_derived_col(col col_ref, expr text) IS '
3791
idempotent
3792
';
3793

    
3794

    
3795
--
3796
-- Name: type_qual(anyelement); Type: FUNCTION; Schema: util; Owner: -
3797
--
3798

    
3799
CREATE FUNCTION type_qual(value anyelement) RETURNS text
3800
    LANGUAGE sql IMMUTABLE
3801
    AS $_$
3802
SELECT CASE WHEN $1 IS NULL THEN '' ELSE $$ NOT NULL$$ END
3803
$_$;
3804

    
3805

    
3806
--
3807
-- Name: FUNCTION type_qual(value anyelement); Type: COMMENT; Schema: util; Owner: -
3808
--
3809

    
3810
COMMENT ON FUNCTION type_qual(value anyelement) IS '
3811
a type''s NOT NULL qualifier
3812
';
3813

    
3814

    
3815
--
3816
-- Name: typed_cols(regtype); Type: FUNCTION; Schema: util; Owner: -
3817
--
3818

    
3819
CREATE FUNCTION typed_cols(type regtype) RETURNS SETOF col_cast
3820
    LANGUAGE sql STABLE
3821
    AS $_$
3822
SELECT (attname::text, atttypid)::util.col_cast
3823
FROM pg_attribute
3824
WHERE attrelid = $1::text::regclass AND attnum >= 1 AND NOT attisdropped
3825
ORDER BY attnum
3826
$_$;
3827

    
3828

    
3829
--
3830
-- Name: typeof(anyelement); Type: FUNCTION; Schema: util; Owner: -
3831
--
3832

    
3833
CREATE FUNCTION typeof(value anyelement) RETURNS text
3834
    LANGUAGE sql IMMUTABLE
3835
    AS $_$
3836
SELECT util.qual_name(pg_typeof($1))
3837
$_$;
3838

    
3839

    
3840
--
3841
-- Name: typeof(text, regtype); Type: FUNCTION; Schema: util; Owner: -
3842
--
3843

    
3844
CREATE FUNCTION typeof(expr text, table_ regtype DEFAULT NULL::regtype) RETURNS regtype
3845
    LANGUAGE plpgsql STABLE
3846
    AS $_$
3847
DECLARE
3848
    type regtype;
3849
BEGIN
3850
    EXECUTE $$SELECT pg_typeof($$||expr||$$)$$||
3851
COALESCE($$ FROM (SELECT (NULL::$$||table_||$$).*) _s$$, '') INTO STRICT type;
3852
    RETURN type;
3853
END;
3854
$_$;
3855

    
3856

    
3857
--
3858
-- Name: use_schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3859
--
3860

    
3861
CREATE FUNCTION use_schema(schema_anchor anyelement) RETURNS void
3862
    LANGUAGE sql
3863
    AS $_$
3864
SELECT util.set_search_path(util.mk_search_path(util.schema($1)))
3865
$_$;
3866

    
3867

    
3868
--
3869
-- Name: FUNCTION use_schema(schema_anchor anyelement); Type: COMMENT; Schema: util; Owner: -
3870
--
3871

    
3872
COMMENT ON FUNCTION use_schema(schema_anchor anyelement) IS '
3873
auto-appends util to the search_path to enable use of util operators
3874
';
3875

    
3876

    
3877
--
3878
-- Name: all_same(anyelement); Type: AGGREGATE; Schema: util; Owner: -
3879
--
3880

    
3881
CREATE AGGREGATE all_same(anyelement) (
3882
    SFUNC = all_same_transform,
3883
    STYPE = anyarray,
3884
    FINALFUNC = all_same_final
3885
);
3886

    
3887

    
3888
--
3889
-- Name: AGGREGATE all_same(anyelement); Type: COMMENT; Schema: util; Owner: -
3890
--
3891

    
3892
COMMENT ON AGGREGATE all_same(anyelement) IS '
3893
includes NULLs in comparison
3894
';
3895

    
3896

    
3897
--
3898
-- Name: join_strs(text, text); Type: AGGREGATE; Schema: util; Owner: -
3899
--
3900

    
3901
CREATE AGGREGATE join_strs(text, text) (
3902
    SFUNC = join_strs_transform,
3903
    STYPE = text
3904
);
3905

    
3906

    
3907
--
3908
-- Name: %==; Type: OPERATOR; Schema: util; Owner: -
3909
--
3910

    
3911
CREATE OPERATOR %== (
3912
    PROCEDURE = "%==",
3913
    LEFTARG = anyelement,
3914
    RIGHTARG = anyelement
3915
);
3916

    
3917

    
3918
--
3919
-- Name: OPERATOR %== (anyelement, anyelement); Type: COMMENT; Schema: util; Owner: -
3920
--
3921

    
3922
COMMENT ON OPERATOR %== (anyelement, anyelement) IS '
3923
returns whether the map-keys of the compared values are the same
3924
(mnemonic: % is the Perl symbol for a hash map)
3925

    
3926
should be overridden for types that store both keys and values
3927

    
3928
used in a FULL JOIN to select which columns to join on
3929
';
3930

    
3931

    
3932
--
3933
-- Name: ->; Type: OPERATOR; Schema: util; Owner: -
3934
--
3935

    
3936
CREATE OPERATOR -> (
3937
    PROCEDURE = map_get,
3938
    LEFTARG = regclass,
3939
    RIGHTARG = text
3940
);
3941

    
3942

    
3943
--
3944
-- Name: =>; Type: OPERATOR; Schema: util; Owner: -
3945
--
3946

    
3947
CREATE OPERATOR => (
3948
    PROCEDURE = hstore,
3949
    LEFTARG = text[],
3950
    RIGHTARG = text
3951
);
3952

    
3953

    
3954
--
3955
-- Name: OPERATOR => (text[], text); Type: COMMENT; Schema: util; Owner: -
3956
--
3957

    
3958
COMMENT ON OPERATOR => (text[], text) IS '
3959
usage: array[''key1'', ...]::text[] => ''value''
3960
';
3961

    
3962

    
3963
--
3964
-- Name: ?*>=; Type: OPERATOR; Schema: util; Owner: -
3965
--
3966

    
3967
CREATE OPERATOR ?*>= (
3968
    PROCEDURE = is_populated_more_often_than,
3969
    LEFTARG = anyelement,
3970
    RIGHTARG = anyelement
3971
);
3972

    
3973

    
3974
--
3975
-- Name: ?>=; Type: OPERATOR; Schema: util; Owner: -
3976
--
3977

    
3978
CREATE OPERATOR ?>= (
3979
    PROCEDURE = is_more_complete_than,
3980
    LEFTARG = anyelement,
3981
    RIGHTARG = anyelement
3982
);
3983

    
3984

    
3985
--
3986
-- Name: ||%; Type: OPERATOR; Schema: util; Owner: -
3987
--
3988

    
3989
CREATE OPERATOR ||% (
3990
    PROCEDURE = concat_esc,
3991
    LEFTARG = text,
3992
    RIGHTARG = text
3993
);
3994

    
3995

    
3996
--
3997
-- Name: OPERATOR ||% (text, text); Type: COMMENT; Schema: util; Owner: -
3998
--
3999

    
4000
COMMENT ON OPERATOR ||% (text, text) IS '
4001
% indicates an identifier, as in Perl hashes and one of the x86 assembler syntaxes for registers
4002
';
4003

    
4004

    
4005
--
4006
-- Name: map; Type: TABLE; Schema: util; Owner: -; Tablespace: 
4007
--
4008

    
4009
CREATE TABLE map (
4010
    "from" text NOT NULL,
4011
    "to" text,
4012
    filter text,
4013
    notes text
4014
);
4015

    
4016

    
4017
--
4018
-- Data for Name: explain; Type: TABLE DATA; Schema: util; Owner: -
4019
--
4020

    
4021

    
4022

    
4023
--
4024
-- Data for Name: map; Type: TABLE DATA; Schema: util; Owner: -
4025
--
4026

    
4027

    
4028

    
4029
--
4030
-- Name: map__unique__from; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
4031
--
4032

    
4033
ALTER TABLE ONLY map
4034
    ADD CONSTRAINT map__unique__from UNIQUE ("from");
4035

    
4036

    
4037
--
4038
-- Name: map__unique__to; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
4039
--
4040

    
4041
ALTER TABLE ONLY map
4042
    ADD CONSTRAINT map__unique__to UNIQUE ("to");
4043

    
4044

    
4045
--
4046
-- Name: map_filter_insert; Type: TRIGGER; Schema: util; Owner: -
4047
--
4048

    
4049
CREATE TRIGGER map_filter_insert BEFORE INSERT ON map FOR EACH ROW EXECUTE PROCEDURE map_filter_insert();
4050

    
4051

    
4052
--
4053
-- PostgreSQL database dump complete
4054
--
4055

    
(19-19/29)