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: db_item; Type: TYPE; Schema: util; Owner: -
76
--
77

    
78
CREATE TYPE db_item AS (
79
	path text,
80
	def text
81
);
82

    
83

    
84
--
85
-- Name: geocoord; Type: TYPE; Schema: util; Owner: -
86
--
87

    
88
CREATE TYPE geocoord AS (
89
	latitude_deg double precision,
90
	longitude_deg double precision
91
);
92

    
93

    
94
--
95
-- Name: range; Type: TYPE; Schema: util; Owner: -
96
--
97

    
98
CREATE TYPE range AS (
99
	lower numeric,
100
	upper numeric,
101
	bounds text
102
);
103

    
104

    
105
--
106
-- Name: TYPE range; Type: COMMENT; Schema: util; Owner: -
107
--
108

    
109
COMMENT ON TYPE range IS '
110
allows wraparound ranges (which use a modulus system such as geocoordinates)
111
';
112

    
113

    
114
--
115
-- Name: restore_views_info; Type: TYPE; Schema: util; Owner: -
116
--
117

    
118
CREATE TYPE restore_views_info AS (
119
	views db_item[]
120
);
121

    
122

    
123
--
124
-- Name: _alt(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
125
--
126

    
127
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
128
    LANGUAGE sql IMMUTABLE
129
    AS $_$
130
SELECT coalesce($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
131
$_$;
132

    
133

    
134
--
135
-- Name: _and(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
136
--
137

    
138
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
139
    LANGUAGE sql IMMUTABLE
140
    AS $_$
141
SELECT bool_and(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: FUNCTION _and("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
156
--
157

    
158
COMMENT ON FUNCTION _and("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
159
_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.
160
';
161

    
162

    
163
--
164
-- Name: _avg(double precision, double precision, double precision, double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
165
--
166

    
167
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
168
    LANGUAGE sql IMMUTABLE
169
    AS $_$
170
SELECT avg(value)
171
FROM
172
(VALUES
173
      ($1)
174
    , ($2)
175
    , ($3)
176
    , ($4)
177
    , ($5)
178
)
179
AS v (value)
180
$_$;
181

    
182

    
183
--
184
-- Name: _dms_to_dd(text); Type: FUNCTION; Schema: util; Owner: -
185
--
186

    
187
CREATE FUNCTION _dms_to_dd(value text DEFAULT NULL::text) RETURNS double precision
188
    LANGUAGE sql IMMUTABLE
189
    AS $_$
190
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)
191
FROM 
192
(
193
    SELECT regexp_matches($1, '^ *(-?)(\d{1,3}(?:\.\d*)?)(?:(?:deg|[°º])(?: *([\d.]+)(?:min|[''’]))?(?: *([\d.]+)(?:sec|["”]))?)? *([NESW])? *$')
194
    UNION ALL
195
    SELECT ARRAY[g[1], g[2], g[3]||'.'||g[4], NULL, g[5]]
196
    FROM regexp_matches($1, '^ *(-?)(\d{2,3})(\d{2})(\d{3}) *([NESW])? *$') matches (g) -- [D]DDMMmmm, where MMmmm = MM.mmm
197
)
198
matches (g)
199
$_$;
200

    
201

    
202
--
203
-- Name: _dms_to_dd(double precision, double precision, double precision, compass_dir); Type: FUNCTION; Schema: util; Owner: -
204
--
205

    
206
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
207
    LANGUAGE sql IMMUTABLE
208
    AS $_$
209
SELECT sum(value)*COALESCE(util._map('N=>1,E=>1,S=>-1,W=>-1', $4::text)::integer, 1)
210
FROM
211
(VALUES
212
      ($1)
213
    , ($2/60)
214
    , ($3/60/60)
215
)
216
AS v (value)
217
$_$;
218

    
219

    
220
--
221
-- Name: _dms_to_dd(text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
222
--
223

    
224
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
225
    LANGUAGE sql IMMUTABLE
226
    AS $_$
227
SELECT util._dms_to_dd($1::double precision, $2::double precision, $3::double precision, $4::util.compass_dir)
228
$_$;
229

    
230

    
231
--
232
-- Name: _eq(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
233
--
234

    
235
CREATE FUNCTION _eq("left" anyelement DEFAULT NULL::unknown, "right" anyelement DEFAULT NULL::unknown) RETURNS boolean
236
    LANGUAGE sql IMMUTABLE
237
    AS $_$
238
SELECT $1 = $2
239
$_$;
240

    
241

    
242
--
243
-- Name: _fix_date(date, date); Type: FUNCTION; Schema: util; Owner: -
244
--
245

    
246
CREATE FUNCTION _fix_date(value date DEFAULT NULL::date, threshold date DEFAULT NULL::date) RETURNS date
247
    LANGUAGE sql IMMUTABLE
248
    AS $_$
249
-- Fix dates after threshold date
250
-- This fixes e.g. 2-digit years before 1970 misinterpreted as 20xx
251
SELECT (CASE WHEN $1 > COALESCE($2, now()) THEN ($1 - '100 years'::interval)::date ELSE $1 END)
252
$_$;
253

    
254

    
255
--
256
-- Name: _if(boolean, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
257
--
258

    
259
CREATE FUNCTION _if(cond boolean DEFAULT NULL::boolean, "then" anyelement DEFAULT NULL::unknown, "else" anyelement DEFAULT NULL::unknown) RETURNS anyelement
260
    LANGUAGE sql IMMUTABLE
261
    AS $_$
262
SELECT (CASE WHEN $1 THEN $2 ELSE $3 END)
263
$_$;
264

    
265

    
266
--
267
-- Name: _if(text, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
268
--
269

    
270
CREATE FUNCTION _if(cond text DEFAULT NULL::text, "then" anyelement DEFAULT NULL::unknown, "else" anyelement DEFAULT NULL::unknown) RETURNS anyelement
271
    LANGUAGE sql IMMUTABLE
272
    AS $_$
273
SELECT util._if($1 != '', $2, $3)
274
$_$;
275

    
276

    
277
--
278
-- Name: _join(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
279
--
280

    
281
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
282
    LANGUAGE sql IMMUTABLE
283
    AS $_$
284
SELECT NULLIF(concat_ws('; ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
285
$_$;
286

    
287

    
288
--
289
-- Name: _join_words(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
290
--
291

    
292
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
293
    LANGUAGE sql IMMUTABLE
294
    AS $_$
295
SELECT NULLIF(concat_ws(' ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
296
$_$;
297

    
298

    
299
--
300
-- Name: _km_to_m(double precision); Type: FUNCTION; Schema: util; Owner: -
301
--
302

    
303
CREATE FUNCTION _km_to_m(value double precision) RETURNS double precision
304
    LANGUAGE sql IMMUTABLE
305
    AS $_$
306
SELECT $1*1000.
307
$_$;
308

    
309

    
310
--
311
-- Name: _label(text, text); Type: FUNCTION; Schema: util; Owner: -
312
--
313

    
314
CREATE FUNCTION _label(label text, value text) RETURNS text
315
    LANGUAGE sql IMMUTABLE
316
    AS $_$
317
SELECT coalesce($1 || ': ', '') || $2
318
$_$;
319

    
320

    
321
--
322
-- Name: _lowercase(text); Type: FUNCTION; Schema: util; Owner: -
323
--
324

    
325
CREATE FUNCTION _lowercase(value text) RETURNS text
326
    LANGUAGE sql IMMUTABLE
327
    AS $_$
328
SELECT lower($1)
329
$_$;
330

    
331

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

    
336
CREATE FUNCTION _map(map hstore, value anyelement) RETURNS anyelement
337
    LANGUAGE plpgsql IMMUTABLE STRICT
338
    AS $$
339
DECLARE
340
    result value%TYPE := util._map(map, value::text)::unknown;
341
BEGIN
342
    RETURN result;
343
END;
344
$$;
345

    
346

    
347
--
348
-- Name: _map(hstore, text); Type: FUNCTION; Schema: util; Owner: -
349
--
350

    
351
CREATE FUNCTION _map(map hstore, value text) RETURNS text
352
    LANGUAGE plpgsql IMMUTABLE STRICT
353
    AS $$
354
DECLARE
355
    match text := map -> value;
356
BEGIN
357
    IF match IS NULL AND NOT map ? value THEN -- no match rather than NULL match
358
        match := map -> '*'; -- use default entry
359
        IF match IS NULL AND NOT map ? '*' THEN match := '!'; -- no default
360
        END IF;
361
    END IF;
362
    
363
    -- Interpret result
364
    IF match = '!' THEN RAISE 'Value not in map: %', value USING ERRCODE = 'data_exception';
365
    ELSIF match = '*' THEN RETURN value;
366
    ELSE RETURN match;
367
    END IF;
368
END;
369
$$;
370

    
371

    
372
--
373
-- Name: _max(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
374
--
375

    
376
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
377
    LANGUAGE sql IMMUTABLE
378
    AS $_$
379
SELECT GREATEST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
380
$_$;
381

    
382

    
383
--
384
-- Name: _merge(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
385
--
386

    
387
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
388
    LANGUAGE sql IMMUTABLE
389
    AS $_$
390
SELECT util.join_strs(value, '; ')
391
FROM
392
(
393
    SELECT *
394
    FROM
395
    (
396
        SELECT
397
        DISTINCT ON (value)
398
        *
399
        FROM
400
        (VALUES
401
              (1, $1)
402
            , (2, $2)
403
            , (3, $3)
404
            , (4, $4)
405
            , (5, $5)
406
            , (6, $6)
407
            , (7, $7)
408
            , (8, $8)
409
            , (9, $9)
410
            , (10, $10)
411
        )
412
        AS v (sort_order, value)
413
        WHERE value IS NOT NULL
414
    )
415
    AS v
416
    ORDER BY sort_order
417
)
418
AS v
419
$_$;
420

    
421

    
422
--
423
-- Name: _merge_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
424
--
425

    
426
CREATE FUNCTION _merge_prefix(prefix text DEFAULT NULL::text, value text DEFAULT NULL::text) RETURNS text
427
    LANGUAGE sql IMMUTABLE
428
    AS $_$
429
SELECT _join_words((CASE WHEN $2 ~ ('^'||$1||E'\\y') THEN NULL ELSE $1 END), $2)
430
$_$;
431

    
432

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

    
437
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
438
    LANGUAGE sql IMMUTABLE
439
    AS $_$
440
SELECT util.join_strs(value, ' ')
441
FROM
442
(
443
    SELECT *
444
    FROM
445
    (
446
        SELECT
447
        DISTINCT ON (value)
448
        *
449
        FROM
450
        (VALUES
451
              (1, $1)
452
            , (2, $2)
453
            , (3, $3)
454
            , (4, $4)
455
            , (5, $5)
456
            , (6, $6)
457
            , (7, $7)
458
            , (8, $8)
459
            , (9, $9)
460
            , (10, $10)
461
        )
462
        AS v (sort_order, value)
463
        WHERE value IS NOT NULL
464
    )
465
    AS v
466
    ORDER BY sort_order
467
)
468
AS v
469
$_$;
470

    
471

    
472
--
473
-- Name: _min(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
474
--
475

    
476
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
477
    LANGUAGE sql IMMUTABLE
478
    AS $_$
479
SELECT LEAST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
480
$_$;
481

    
482

    
483
--
484
-- Name: _not(boolean); Type: FUNCTION; Schema: util; Owner: -
485
--
486

    
487
CREATE FUNCTION _not(value boolean) RETURNS boolean
488
    LANGUAGE sql IMMUTABLE
489
    AS $_$
490
SELECT NOT $1
491
$_$;
492

    
493

    
494
--
495
-- Name: _now(); Type: FUNCTION; Schema: util; Owner: -
496
--
497

    
498
CREATE FUNCTION _now() RETURNS timestamp with time zone
499
    LANGUAGE sql STABLE
500
    AS $$
501
SELECT now()
502
$$;
503

    
504

    
505
--
506
-- Name: _nullIf(anyelement, text, text); Type: FUNCTION; Schema: util; Owner: -
507
--
508

    
509
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type text) RETURNS anyelement
510
    LANGUAGE sql IMMUTABLE
511
    AS $_$
512
SELECT util."_nullIf"($1, $2, $3::util.datatype)
513
$_$;
514

    
515

    
516
--
517
-- Name: _nullIf(anyelement, text, datatype); Type: FUNCTION; Schema: util; Owner: -
518
--
519

    
520
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type datatype DEFAULT 'str'::datatype) RETURNS anyelement
521
    LANGUAGE plpgsql IMMUTABLE
522
    AS $$
523
DECLARE
524
    type util.datatype NOT NULL := type; -- add NOT NULL
525
BEGIN
526
    IF type = 'str' THEN RETURN nullif(value::text, "null");
527
    -- Invalid value is ignored, but invalid null value generates error
528
    ELSIF type = 'float' THEN
529
        DECLARE
530
            -- Outside the try block so that invalid null value generates error
531
            "null" double precision := "null"::double precision;
532
        BEGIN
533
            RETURN nullif(value::double precision, "null");
534
        EXCEPTION
535
            WHEN data_exception THEN RETURN value; -- ignore invalid value
536
        END;
537
    END IF;
538
END;
539
$$;
540

    
541

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

    
546
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
547
    LANGUAGE sql IMMUTABLE
548
    AS $_$
549
SELECT bool_or(value)
550
FROM
551
(VALUES
552
      ($1)
553
    , ($2)
554
    , ($3)
555
    , ($4)
556
    , ($5)
557
)
558
AS v (value)
559
$_$;
560

    
561

    
562
--
563
-- Name: FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
564
--
565

    
566
COMMENT ON FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
567
_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.
568
';
569

    
570

    
571
--
572
-- Name: _range(double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
573
--
574

    
575
CREATE FUNCTION _range("from" double precision DEFAULT NULL::double precision, "to" double precision DEFAULT NULL::double precision) RETURNS double precision
576
    LANGUAGE sql IMMUTABLE
577
    AS $_$
578
SELECT $2 - $1
579
$_$;
580

    
581

    
582
--
583
-- Name: _split(text, text); Type: FUNCTION; Schema: util; Owner: -
584
--
585

    
586
CREATE FUNCTION _split(value text DEFAULT NULL::text, separator text DEFAULT '; '::text) RETURNS SETOF text
587
    LANGUAGE sql IMMUTABLE
588
    AS $_$
589
SELECT regexp_split_to_table($1, $2)
590
$_$;
591

    
592

    
593
--
594
-- Name: added_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
595
--
596

    
597
CREATE FUNCTION added_cols(table_ regclass, names regclass) RETURNS SETOF text
598
    LANGUAGE sql STABLE
599
    AS $_$
600
SELECT util.derived_cols($1, $2)
601
UNION
602
SELECT util.eval2set($$
603
SELECT col
604
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
605
JOIN $$||$2||$$ ON "to" = col
606
WHERE "from" LIKE ':%'
607
$$, NULL::text)
608
$_$;
609

    
610

    
611
--
612
-- Name: FUNCTION added_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
613
--
614

    
615
COMMENT ON FUNCTION added_cols(table_ regclass, names regclass) IS '
616
gets table_''s added columns (all the columns not in the original data)
617
';
618

    
619

    
620
--
621
-- Name: all_same_final(anyarray); Type: FUNCTION; Schema: util; Owner: -
622
--
623

    
624
CREATE FUNCTION all_same_final(state anyarray) RETURNS boolean
625
    LANGUAGE sql IMMUTABLE
626
    AS $_$
627
SELECT $1 IS NULL/*no rows*/ OR util.not_empty($1)/*not no_match_sentinel*/
628
$_$;
629

    
630

    
631
--
632
-- Name: all_same_transform(anyarray, anyelement); Type: FUNCTION; Schema: util; Owner: -
633
--
634

    
635
CREATE FUNCTION all_same_transform(state anyarray, value anyelement) RETURNS anyarray
636
    LANGUAGE plpgsql IMMUTABLE
637
    AS $$
638
DECLARE
639
	value_cmp         state%TYPE = ARRAY[value];
640
	state             state%TYPE = COALESCE(state, value_cmp);
641
	no_match_sentinel state%TYPE = value_cmp[1:0]/*=ARRAY[]::state%TYPE*/;
642
BEGIN
643
	RETURN (CASE WHEN value_cmp IS NOT DISTINCT FROM state THEN state ELSE no_match_sentinel END);
644
END;
645
$$;
646

    
647

    
648
--
649
-- Name: analyze_(regclass); Type: FUNCTION; Schema: util; Owner: -
650
--
651

    
652
CREATE FUNCTION analyze_(table_ regclass) RETURNS void
653
    LANGUAGE sql
654
    AS $_$
655
SELECT util.eval($$ANALYZE VERBOSE $$||$1)
656
$_$;
657

    
658

    
659
--
660
-- Name: append_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
661
--
662

    
663
CREATE FUNCTION append_comment(table_ regclass, comment text) RETURNS void
664
    LANGUAGE sql
665
    AS $_$
666
SELECT util.set_comment($1, concat(util.comment($1), $2))
667
$_$;
668

    
669

    
670
--
671
-- Name: FUNCTION append_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
672
--
673

    
674
COMMENT ON FUNCTION append_comment(table_ regclass, comment text) IS '
675
comment: must start and end with a newline
676
';
677

    
678

    
679
--
680
-- Name: array_fill(anyelement, integer); Type: FUNCTION; Schema: util; Owner: -
681
--
682

    
683
CREATE FUNCTION array_fill(value anyelement, length integer) RETURNS anyarray
684
    LANGUAGE sql IMMUTABLE
685
    AS $_$
686
SELECT pg_catalog.array_fill($1, ARRAY[$2])
687
$_$;
688

    
689

    
690
--
691
-- Name: array_length(anyarray); Type: FUNCTION; Schema: util; Owner: -
692
--
693

    
694
CREATE FUNCTION array_length("array" anyarray) RETURNS integer
695
    LANGUAGE sql IMMUTABLE
696
    AS $_$
697
SELECT util.array_length($1, 1)
698
$_$;
699

    
700

    
701
--
702
-- Name: array_length(anyarray, integer); Type: FUNCTION; Schema: util; Owner: -
703
--
704

    
705
CREATE FUNCTION array_length("array" anyarray, dimension integer) RETURNS integer
706
    LANGUAGE sql IMMUTABLE
707
    AS $_$
708
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE COALESCE(pg_catalog.array_length($1, $2), 0) END
709
$_$;
710

    
711

    
712
--
713
-- Name: FUNCTION array_length("array" anyarray, dimension integer); Type: COMMENT; Schema: util; Owner: -
714
--
715

    
716
COMMENT ON FUNCTION array_length("array" anyarray, dimension integer) IS '
717
returns 0 instead of NULL for empty arrays
718
';
719

    
720

    
721
--
722
-- Name: array_reverse(anyarray); Type: FUNCTION; Schema: util; Owner: -
723
--
724

    
725
CREATE FUNCTION array_reverse("array" anyarray) RETURNS anyarray
726
    LANGUAGE sql IMMUTABLE
727
    AS $_$
728
SELECT array(SELECT elem FROM util.in_reverse($1) elem)
729
$_$;
730

    
731

    
732
--
733
-- Name: auto_rm_freq(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
734
--
735

    
736
CREATE FUNCTION auto_rm_freq(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS void
737
    LANGUAGE sql
738
    AS $_$
739
SELECT CASE WHEN util.freq_always_1($1, $2)
740
THEN util.rm_freq($1, $2)
741
ELSE util.try_create($$ALTER TABLE $$||util.parent($1[1])||$$ ADD COLUMN $$||quote_ident($2)||$$ bigint NOT NULL$$)
742
END
743
$_$;
744

    
745

    
746
--
747
-- Name: bounding_box(range, range); Type: FUNCTION; Schema: util; Owner: -
748
--
749

    
750
CREATE FUNCTION bounding_box(latitude_range_deg range, longitude_range_deg range) RETURNS postgis.geography
751
    LANGUAGE sql IMMUTABLE
752
    AS $_$
753
SELECT util.bounding_box__no_dateline($1, $2)::postgis.geography
754
$_$;
755

    
756

    
757
--
758
-- Name: FUNCTION bounding_box(latitude_range_deg range, longitude_range_deg range); Type: COMMENT; Schema: util; Owner: -
759
--
760

    
761
COMMENT ON FUNCTION bounding_box(latitude_range_deg range, longitude_range_deg range) IS '
762
usage:
763
SET search_path = util; -- for ~ operator
764
SELECT util.bounding_box(lower_lat ~ upper_lat, lower_long ~ upper_long);
765

    
766
**WARNING**: the geography type stores all edges as arcs of great circles,
767
resulting in the latitude lines bulging outward from the true bounding box.
768
this will create false positives above and below the bounding box.
769
';
770

    
771

    
772
--
773
-- Name: bounding_box__no_dateline(range, range); Type: FUNCTION; Schema: util; Owner: -
774
--
775

    
776
CREATE FUNCTION bounding_box__no_dateline(latitude_range_deg range, longitude_range_deg range) RETURNS postgis.geometry
777
    LANGUAGE sql IMMUTABLE
778
    AS $_$
779
/* don't use st_makebox2d() because it doesn't support geocoordinate wraparound
780
(it is not SRID-aware) */
781
SELECT postgis.st_makeenvelope(
782
  /*xmin=*/$2.lower, /*ymin=*/$1.lower
783
, /*xmax=*/$2.upper, /*ymax=*/$1.upper
784
, /*WGS84*/4326
785
)
786
$_$;
787

    
788

    
789
--
790
-- Name: FUNCTION bounding_box__no_dateline(latitude_range_deg range, longitude_range_deg range); Type: COMMENT; Schema: util; Owner: -
791
--
792

    
793
COMMENT ON FUNCTION bounding_box__no_dateline(latitude_range_deg range, longitude_range_deg range) IS '
794
the generated bounding box is more accurate than util.bounding_box() (latitude
795
lines will be straight), but geocoordinate wraparound is not supported
796

    
797
usage:
798
SET search_path = util; -- for ~ operator
799
SELECT util.bounding_box__no_dateline(lower_lat ~ upper_lat, lower_long ~ upper_long);
800
';
801

    
802

    
803
--
804
-- Name: cast(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
805
--
806

    
807
CREATE FUNCTION "cast"(value text, ret_type_null anyelement) RETURNS anyelement
808
    LANGUAGE plpgsql IMMUTABLE
809
    AS $$
810
/* must use LANGUAGE plpgsql because LANGUAGE sql does not assignment-cast the
811
return value, causing a type mismatch */
812
BEGIN
813
	-- will then be assignment-cast to return type via INOUT
814
	RETURN value::cstring;
815
END;
816
$$;
817

    
818

    
819
--
820
-- Name: FUNCTION "cast"(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
821
--
822

    
823
COMMENT ON FUNCTION "cast"(value text, ret_type_null anyelement) IS '
824
allows casting to an arbitrary type without eval()
825

    
826
usage:
827
SELECT util.cast(''value'', NULL::integer);
828

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

    
833
ret_type_null: NULL::ret_type
834
';
835

    
836

    
837
--
838
-- Name: cluster_index(regclass); Type: FUNCTION; Schema: util; Owner: -
839
--
840

    
841
CREATE FUNCTION cluster_index(table_ regclass) RETURNS regclass
842
    LANGUAGE sql STABLE
843
    AS $_$
844
SELECT indexrelid FROM pg_index WHERE indrelid = $1 AND indisclustered
845
$_$;
846

    
847

    
848
--
849
-- Name: cluster_once(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
850
--
851

    
852
CREATE FUNCTION cluster_once(table_ regclass, index regclass) RETURNS void
853
    LANGUAGE plpgsql STRICT
854
    AS $_$
855
BEGIN
856
    -- not yet clustered (ARRAY[] compares NULLs literally)
857
    IF ARRAY[util.cluster_index(table_)] != ARRAY[index] THEN
858
        EXECUTE $$CLUSTER $$||table_||$$ USING $$||index;
859
    END IF;
860
END;
861
$_$;
862

    
863

    
864
--
865
-- Name: FUNCTION cluster_once(table_ regclass, index regclass); Type: COMMENT; Schema: util; Owner: -
866
--
867

    
868
COMMENT ON FUNCTION cluster_once(table_ regclass, index regclass) IS '
869
idempotent
870
';
871

    
872

    
873
--
874
-- Name: coalesce(anyarray); Type: FUNCTION; Schema: util; Owner: -
875
--
876

    
877
CREATE FUNCTION "coalesce"(VARIADIC values_ anyarray) RETURNS anyelement
878
    LANGUAGE sql IMMUTABLE
879
    AS $_$
880
SELECT value
881
FROM unnest($1) value
882
WHERE value IS NOT NULL
883
LIMIT 1
884
$_$;
885

    
886

    
887
--
888
-- Name: FUNCTION "coalesce"(VARIADIC values_ anyarray); Type: COMMENT; Schema: util; Owner: -
889
--
890

    
891
COMMENT ON FUNCTION "coalesce"(VARIADIC values_ anyarray) IS '
892
uses:
893
* coalescing array elements or rows together
894
* forcing evaluation of all values of a COALESCE()
895
';
896

    
897

    
898
--
899
-- Name: col__min(col_ref); Type: FUNCTION; Schema: util; Owner: -
900
--
901

    
902
CREATE FUNCTION col__min(col col_ref) RETURNS integer
903
    LANGUAGE sql STABLE
904
    AS $_$
905
SELECT util.eval2val($$
906
SELECT $$||quote_ident($1.name)||$$
907
FROM $$||$1.table_||$$
908
ORDER BY $$||quote_ident($1.name)||$$ ASC
909
LIMIT 1
910
$$, NULL::integer)
911
$_$;
912

    
913

    
914
--
915
-- Name: col_comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
916
--
917

    
918
CREATE FUNCTION col_comment(col col_ref) RETURNS text
919
    LANGUAGE plpgsql STABLE STRICT
920
    AS $$
921
DECLARE
922
	comment text;
923
BEGIN
924
	SELECT description
925
	FROM pg_attribute
926
	LEFT JOIN pg_description ON objoid = attrelid
927
		AND classoid = 'pg_class'::regclass AND objsubid = attnum
928
	WHERE attrelid = col.table_ AND attname = col.name
929
	INTO STRICT comment
930
	;
931
	RETURN comment;
932
EXCEPTION
933
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
934
END;
935
$$;
936

    
937

    
938
--
939
-- Name: col_default_sql(col_ref); Type: FUNCTION; Schema: util; Owner: -
940
--
941

    
942
CREATE FUNCTION col_default_sql(col col_ref) RETURNS text
943
    LANGUAGE plpgsql STABLE STRICT
944
    AS $$
945
DECLARE
946
	default_sql text;
947
BEGIN
948
	SELECT adsrc
949
	FROM pg_attribute
950
	LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum
951
	WHERE attrelid = col.table_ AND attname = col.name
952
	INTO STRICT default_sql
953
	;
954
	RETURN default_sql;
955
EXCEPTION
956
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
957
END;
958
$$;
959

    
960

    
961
--
962
-- Name: col_default_value(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
963
--
964

    
965
CREATE FUNCTION col_default_value(col col_ref, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
966
    LANGUAGE sql STABLE
967
    AS $_$
968
SELECT util.eval_expr_passthru(util.col_default_sql($1), $2)
969
$_$;
970

    
971

    
972
--
973
-- Name: FUNCTION col_default_value(col col_ref, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
974
--
975

    
976
COMMENT ON FUNCTION col_default_value(col col_ref, ret_type_null anyelement) IS '
977
ret_type_null: NULL::ret_type
978
';
979

    
980

    
981
--
982
-- Name: col_exists(col_ref); Type: FUNCTION; Schema: util; Owner: -
983
--
984

    
985
CREATE FUNCTION col_exists(col col_ref) RETURNS boolean
986
    LANGUAGE plpgsql STRICT
987
    AS $$
988
BEGIN
989
    PERFORM util.col_type(col);
990
    RETURN true;
991
EXCEPTION
992
    WHEN undefined_column THEN RETURN false;
993
END;
994
$$;
995

    
996

    
997
--
998
-- Name: col_global_names(regtype); Type: FUNCTION; Schema: util; Owner: -
999
--
1000

    
1001
CREATE FUNCTION col_global_names(type regtype, OUT name text, OUT global_name text) RETURNS SETOF record
1002
    LANGUAGE plpgsql STABLE STRICT
1003
    AS $$
1004
DECLARE
1005
    prefix text := util.name(type)||'.';
1006
BEGIN
1007
    RETURN QUERY
1008
        SELECT name_, (CASE WHEN util.contains(search_for:='.', in_str:=name_) THEN '' ELSE prefix END)||name_
1009
        FROM util.col_names(type) f (name_);
1010
END;
1011
$$;
1012

    
1013

    
1014
--
1015
-- Name: col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
1016
--
1017

    
1018
CREATE FUNCTION col_names(table_ regclass) RETURNS SETOF text
1019
    LANGUAGE sql STABLE
1020
    AS $_$
1021
SELECT attname::text
1022
FROM pg_attribute
1023
WHERE attrelid = $1 AND attnum >= 1 AND NOT attisdropped
1024
ORDER BY attnum
1025
$_$;
1026

    
1027

    
1028
--
1029
-- Name: col_names(regtype); Type: FUNCTION; Schema: util; Owner: -
1030
--
1031

    
1032
CREATE FUNCTION col_names(type regtype) RETURNS SETOF text
1033
    LANGUAGE plpgsql STABLE STRICT
1034
    AS $_$
1035
BEGIN
1036
    RETURN QUERY EXECUTE $$SELECT skeys(hstore(NULL::$$||type||$$))$$;
1037
END;
1038
$_$;
1039

    
1040

    
1041
--
1042
-- Name: col_num(col_ref); Type: FUNCTION; Schema: util; Owner: -
1043
--
1044

    
1045
CREATE FUNCTION col_num(col col_ref) RETURNS smallint
1046
    LANGUAGE sql STABLE
1047
    AS $_$
1048
SELECT attnum FROM pg_attribute WHERE attrelid = $1.table_ AND attname = $1.name
1049
$_$;
1050

    
1051

    
1052
--
1053
-- Name: col_type(col_ref); Type: FUNCTION; Schema: util; Owner: -
1054
--
1055

    
1056
CREATE FUNCTION col_type(col col_ref) RETURNS regtype
1057
    LANGUAGE plpgsql STABLE STRICT
1058
    AS $$
1059
DECLARE
1060
    type regtype;
1061
BEGIN
1062
    SELECT atttypid FROM pg_attribute
1063
    WHERE attrelid = col.table_ AND attname = col.name
1064
    INTO STRICT type
1065
    ;
1066
    RETURN type;
1067
EXCEPTION
1068
    WHEN no_data_found THEN
1069
        RAISE undefined_column USING MESSAGE =
1070
            concat('undefined column: ', col.name);
1071
END;
1072
$$;
1073

    
1074

    
1075
--
1076
-- Name: comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
1077
--
1078

    
1079
CREATE FUNCTION comment(col col_ref) RETURNS text
1080
    LANGUAGE sql STABLE
1081
    AS $_$
1082
SELECT description
1083
FROM pg_description
1084
WHERE
1085
	objoid = $1.table_
1086
AND classoid = 'pg_class'::regclass
1087
AND objsubid = util.col_num($1)
1088
$_$;
1089

    
1090

    
1091
--
1092
-- Name: comment(oid); Type: FUNCTION; Schema: util; Owner: -
1093
--
1094

    
1095
CREATE FUNCTION comment(element oid) RETURNS text
1096
    LANGUAGE sql STABLE
1097
    AS $_$
1098
SELECT description FROM pg_description WHERE objoid = $1
1099
$_$;
1100

    
1101

    
1102
--
1103
-- Name: concat_esc(text, text); Type: FUNCTION; Schema: util; Owner: -
1104
--
1105

    
1106
CREATE FUNCTION concat_esc("left" text, "right" text) RETURNS text
1107
    LANGUAGE sql IMMUTABLE
1108
    AS $_$
1109
SELECT util.esc_name__append($2, $1)
1110
$_$;
1111

    
1112

    
1113
--
1114
-- Name: contained_within__no_dateline(postgis.geometry, postgis.geometry); Type: FUNCTION; Schema: util; Owner: -
1115
--
1116

    
1117
CREATE FUNCTION contained_within__no_dateline("inner" postgis.geometry, "outer" postgis.geometry) RETURNS boolean
1118
    LANGUAGE sql IMMUTABLE
1119
    SET search_path TO postgis
1120
    AS $_$
1121
/* search_path: st_coveredby() needs postgis to be in the search_path */
1122
/* must be st_coveredby() rather than st_within() to avoid unexpected behavior
1123
at the shape border */
1124
SELECT postgis.st_coveredby($1, $2)
1125
$_$;
1126

    
1127

    
1128
--
1129
-- Name: FUNCTION contained_within__no_dateline("inner" postgis.geometry, "outer" postgis.geometry); Type: COMMENT; Schema: util; Owner: -
1130
--
1131

    
1132
COMMENT ON FUNCTION contained_within__no_dateline("inner" postgis.geometry, "outer" postgis.geometry) IS '
1133
**WARNING**: this will not work on shapes that cross the date line, as the
1134
geometry type does not support geocoordinate wraparound
1135
';
1136

    
1137

    
1138
--
1139
-- Name: contained_within__no_dateline(geocoord, postgis.geometry); Type: FUNCTION; Schema: util; Owner: -
1140
--
1141

    
1142
CREATE FUNCTION contained_within__no_dateline(point geocoord, region postgis.geometry) RETURNS boolean
1143
    LANGUAGE sql IMMUTABLE
1144
    AS $_$
1145
SELECT util.contained_within__no_dateline(util.geometry($1), $2)
1146
$_$;
1147

    
1148

    
1149
--
1150
-- Name: FUNCTION contained_within__no_dateline(point geocoord, region postgis.geometry); Type: COMMENT; Schema: util; Owner: -
1151
--
1152

    
1153
COMMENT ON FUNCTION contained_within__no_dateline(point geocoord, region postgis.geometry) IS '
1154
defining this in addition to contained_within_approx(geometry, geometry) enables
1155
specifying just `(lat, long)` without the ::util.geocoord type specifier
1156
';
1157

    
1158

    
1159
--
1160
-- Name: contained_within_approx(postgis.geography, postgis.geography); Type: FUNCTION; Schema: util; Owner: -
1161
--
1162

    
1163
CREATE FUNCTION contained_within_approx("inner" postgis.geography, "outer" postgis.geography) RETURNS boolean
1164
    LANGUAGE sql IMMUTABLE
1165
    SET search_path TO postgis
1166
    AS $_$
1167
/* search_path: st_coveredby() needs postgis to be in the search_path */
1168
SELECT postgis.st_coveredby($1, $2)
1169
$_$;
1170

    
1171

    
1172
--
1173
-- Name: FUNCTION contained_within_approx("inner" postgis.geography, "outer" postgis.geography); Type: COMMENT; Schema: util; Owner: -
1174
--
1175

    
1176
COMMENT ON FUNCTION contained_within_approx("inner" postgis.geography, "outer" postgis.geography) IS '
1177
**WARNING**: the geography type stores all edges as arcs of great circles,
1178
resulting in the latitude lines of bounding boxes bulging outward from the true
1179
bounding box. this will create false positives above and below the bounding box.
1180
';
1181

    
1182

    
1183
--
1184
-- Name: contained_within_approx(geocoord, postgis.geography); Type: FUNCTION; Schema: util; Owner: -
1185
--
1186

    
1187
CREATE FUNCTION contained_within_approx(point geocoord, region postgis.geography) RETURNS boolean
1188
    LANGUAGE sql IMMUTABLE
1189
    AS $_$
1190
SELECT util.contained_within_approx(util.geometry($1), $2)
1191
$_$;
1192

    
1193

    
1194
--
1195
-- Name: FUNCTION contained_within_approx(point geocoord, region postgis.geography); Type: COMMENT; Schema: util; Owner: -
1196
--
1197

    
1198
COMMENT ON FUNCTION contained_within_approx(point geocoord, region postgis.geography) IS '
1199
defining this in addition to contained_within_approx(geography, geography)
1200
enables specifying just `(lat, long)` without the ::util.geocoord type specifier
1201
';
1202

    
1203

    
1204
--
1205
-- Name: contains(text, text); Type: FUNCTION; Schema: util; Owner: -
1206
--
1207

    
1208
CREATE FUNCTION contains(search_for text, in_str text) RETURNS boolean
1209
    LANGUAGE sql IMMUTABLE
1210
    AS $_$
1211
SELECT position($1 in $2) > 0 /*1-based offset*/
1212
$_$;
1213

    
1214

    
1215
--
1216
-- Name: copy(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1217
--
1218

    
1219
CREATE FUNCTION copy(from_ regclass, to_ text) RETURNS void
1220
    LANGUAGE sql
1221
    AS $_$
1222
SELECT util.copy_struct($1, $2);
1223
SELECT util.copy_data($1, $2);
1224
$_$;
1225

    
1226

    
1227
--
1228
-- Name: copy_data(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1229
--
1230

    
1231
CREATE FUNCTION copy_data(from_ regclass, to_ regclass) RETURNS void
1232
    LANGUAGE sql
1233
    AS $_$
1234
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT * FROM $$||$1)
1235
$_$;
1236

    
1237

    
1238
--
1239
-- Name: copy_struct(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1240
--
1241

    
1242
CREATE FUNCTION copy_struct(from_ regclass, to_ text) RETURNS void
1243
    LANGUAGE sql
1244
    AS $_$
1245
SELECT util.eval($$CREATE TABLE $$||$2||$$ (LIKE $$||$1||$$ INCLUDING ALL)$$)
1246
$_$;
1247

    
1248

    
1249
--
1250
-- Name: copy_types_and_data(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1251
--
1252

    
1253
CREATE FUNCTION copy_types_and_data(from_ regclass, to_ text) RETURNS void
1254
    LANGUAGE sql
1255
    AS $_$
1256
SELECT util.materialize_view($2, $1)
1257
$_$;
1258

    
1259

    
1260
--
1261
-- Name: create_if_not_exists(text, text); Type: FUNCTION; Schema: util; Owner: -
1262
--
1263

    
1264
CREATE FUNCTION create_if_not_exists(sql text, relation text DEFAULT NULL::text) RETURNS void
1265
    LANGUAGE plpgsql
1266
    AS $$
1267
BEGIN
1268
	/* always generate standard exception if exists, even if table definition
1269
	would be invalid (which generates a variety of exceptions) */
1270
	IF util.relation_exists(relation) THEN
1271
		PERFORM util.raise('NOTICE', relation||' already exists, skipping');
1272
		RAISE duplicate_table;
1273
	END IF;
1274
	PERFORM util.eval(sql);
1275
EXCEPTION
1276
WHEN   duplicate_table
1277
	OR duplicate_object -- eg. constraint
1278
	OR duplicate_column
1279
	OR duplicate_function
1280
THEN NULL;
1281
WHEN invalid_table_definition THEN
1282
	IF SQLERRM LIKE 'multiple primary keys for table % are not allowed' THEN NULL;
1283
	ELSE RAISE;
1284
	END IF;
1285
END;
1286
$$;
1287

    
1288

    
1289
--
1290
-- Name: FUNCTION create_if_not_exists(sql text, relation text); Type: COMMENT; Schema: util; Owner: -
1291
--
1292

    
1293
COMMENT ON FUNCTION create_if_not_exists(sql text, relation text) IS '
1294
idempotent
1295
';
1296

    
1297

    
1298
--
1299
-- Name: curr_func(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1300
--
1301

    
1302
CREATE FUNCTION curr_func(func text, schema_anchor anyelement) RETURNS text
1303
    LANGUAGE sql STABLE
1304
    AS $$
1305
SELECT util.schema_esc(schema_anchor)||'.'||quote_ident(func)
1306
$$;
1307

    
1308

    
1309
--
1310
-- Name: debug_print_func_call(text); Type: FUNCTION; Schema: util; Owner: -
1311
--
1312

    
1313
CREATE FUNCTION debug_print_func_call(func_call text) RETURNS void
1314
    LANGUAGE sql IMMUTABLE
1315
    AS $_$
1316
SELECT util.raise('NOTICE', $$SELECT $$||$1)
1317
$_$;
1318

    
1319

    
1320
--
1321
-- Name: debug_print_return_value(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1322
--
1323

    
1324
CREATE FUNCTION debug_print_return_value(value anyelement, encode boolean DEFAULT false) RETURNS anyelement
1325
    LANGUAGE sql IMMUTABLE
1326
    AS $_$
1327
SELECT util.debug_print_value('returns: ', $1, $2);
1328
SELECT $1;
1329
$_$;
1330

    
1331

    
1332
--
1333
-- Name: debug_print_sql(text); Type: FUNCTION; Schema: util; Owner: -
1334
--
1335

    
1336
CREATE FUNCTION debug_print_sql(sql text) RETURNS void
1337
    LANGUAGE sql IMMUTABLE
1338
    AS $_$
1339
/* newline before so the query starts at the beginning of the line.
1340
newline after to visually separate queries from one another. */
1341
SELECT util.raise('NOTICE', $$
1342
$$||util.runnable_sql($1)||$$
1343
$$||COALESCE(util.explain2notice_msg_if_can($1), ''))
1344
$_$;
1345

    
1346

    
1347
--
1348
-- Name: debug_print_value(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1349
--
1350

    
1351
CREATE FUNCTION debug_print_value(label text, value anyelement, encode boolean DEFAULT false) RETURNS void
1352
    LANGUAGE sql IMMUTABLE
1353
    AS $_$
1354
SELECT util.raise('NOTICE', concat($1,
1355
(CASE WHEN $3 THEN util.quote_typed($2) ELSE $2::text END))||$$
1356
$$)
1357
$_$;
1358

    
1359

    
1360
--
1361
-- Name: debug_print_var(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1362
--
1363

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

    
1373

    
1374
--
1375
-- Name: derived_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1376
--
1377

    
1378
CREATE FUNCTION derived_cols(table_ regclass, names regclass) RETURNS SETOF text
1379
    LANGUAGE sql STABLE
1380
    AS $_$
1381
SELECT util.eval2set($$
1382
SELECT col
1383
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
1384
LEFT JOIN $$||$2||$$ ON "to" = col
1385
WHERE "from" IS NULL
1386
$$, NULL::text)
1387
$_$;
1388

    
1389

    
1390
--
1391
-- Name: FUNCTION derived_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
1392
--
1393

    
1394
COMMENT ON FUNCTION derived_cols(table_ regclass, names regclass) IS '
1395
gets table_''s derived columns (all the columns not in the names table)
1396
';
1397

    
1398

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

    
1403
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1404
    LANGUAGE sql
1405
    AS $_$
1406
-- create a diff when the # of copies of a row differs between the tables
1407
SELECT util.to_freq($1);
1408
SELECT util.to_freq($2);
1409
SELECT util.auto_rm_freq(ARRAY[$1, $2]);
1410

    
1411
SELECT * FROM util.diff($1, $2, $3, has_freq := true)
1412
$_$;
1413

    
1414

    
1415
--
1416
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1417
--
1418

    
1419
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1420
usage:
1421
SELECT * FROM util.diff(''"left_table"''::regclass, ''"right_table"''::regclass, NULL::shared_base_type)
1422

    
1423
col_type_null (*required*): NULL::shared_base_type
1424
';
1425

    
1426

    
1427
--
1428
-- Name: diff(text, text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1429
--
1430

    
1431
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
1432
    LANGUAGE plpgsql
1433
    SET search_path TO pg_temp
1434
    AS $_$
1435
/* must use LANGUAGE plpgsql because LANGUAGE sql does not support runtime
1436
changes of search_path (schema elements are bound at inline time rather than
1437
runtime) */
1438
/* function option search_path is needed to limit the effects of
1439
`SET LOCAL search_path` to the current function */
1440
BEGIN
1441
	PERFORM util.use_schema($3); -- includes util.%== as default/fallback
1442
	
1443
	PERFORM util.mk_keys_func(pg_typeof($3));
1444
	RETURN QUERY
1445
		SELECT * FROM util.eval2col_pair(util.mk_diff_query($1, $2,
1446
$$/* need to explicitly cast each side to the return type because this does not
1447
happen automatically even when an implicit cast is available */
1448
  left_::$$||util.typeof($3)||$$
1449
, right_::$$||util.typeof($3)
1450
/* when using the util.%==(anyelement, anyelement) operator, you must cast to
1451
the *same* base type, *even though* this is optional when using a custom %== */
1452
, util._if($4, $$true/*= CROSS JOIN*/$$,
1453
$$ left_::$$||util.typeof($3)||$$
1454
%== right_::$$||util.typeof($3)||$$
1455
	-- refer to EXPLAIN output for expansion of %==$$
1456
)
1457
,     $$         left_::$$||util.typeof($3)||$$
1458
IS DISTINCT FROM right_::$$||util.typeof($3)
1459
), $3)
1460
	;
1461
END;
1462
$_$;
1463

    
1464

    
1465
--
1466
-- 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: -
1467
--
1468

    
1469
COMMENT ON FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1470
col_type_null (*required*): NULL::col_type
1471
single_row: whether the tables consist of a single row, which should be
1472
	displayed side-by-side
1473

    
1474
to match up rows using a subset of the columns, create a custom keys() function
1475
which returns this subset as a record:
1476
-- note that OUT parameters for the returned fields are *not* needed
1477
CREATE OR REPLACE FUNCTION [schema].keys(value [schema].[base_type])
1478
  RETURNS record AS
1479
$BODY$
1480
SELECT ($1.key_field_0, $1.key_field_1)
1481
$BODY$
1482
  LANGUAGE sql IMMUTABLE
1483
  COST 100;
1484

    
1485

    
1486
to run EXPLAIN on the FULL JOIN query:
1487
# run this function
1488
# look for a NOTICE containing the expanded query that it ran
1489
# run EXPLAIN on this expanded query
1490
';
1491

    
1492

    
1493
--
1494
-- Name: diff(regclass, regclass, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1495
--
1496

    
1497
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
1498
    LANGUAGE sql
1499
    AS $_$
1500
SELECT * FROM util.diff($1::text, $2::text, $3,
1501
	single_row := util.has_single_row($1) AND util.has_single_row($2))
1502
$_$;
1503

    
1504

    
1505
--
1506
-- 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: -
1507
--
1508

    
1509
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, has_freq boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1510
helper function used by diff(regclass, regclass)
1511

    
1512
usage:
1513
SELECT * FROM util.diff(''"left_freq_table"''::regclass, ''"right_freq_table"''::regclass, NULL::shared_base_type, has_freq := true)
1514

    
1515
col_type_null (*required*): NULL::shared_base_type
1516
';
1517

    
1518

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

    
1523
CREATE FUNCTION do_optionally_ignore(sql text, ignore boolean) RETURNS void
1524
    LANGUAGE sql
1525
    AS $_$
1526
SELECT CASE WHEN $2 THEN util.try_create($1) ELSE util.create_if_not_exists($1) END
1527
$_$;
1528

    
1529

    
1530
--
1531
-- Name: FUNCTION do_optionally_ignore(sql text, ignore boolean); Type: COMMENT; Schema: util; Owner: -
1532
--
1533

    
1534
COMMENT ON FUNCTION do_optionally_ignore(sql text, ignore boolean) IS '
1535
idempotent
1536
';
1537

    
1538

    
1539
--
1540
-- Name: drop_column(col_ref, boolean); Type: FUNCTION; Schema: util; Owner: -
1541
--
1542

    
1543
CREATE FUNCTION drop_column(col col_ref, force boolean DEFAULT false) RETURNS void
1544
    LANGUAGE sql
1545
    AS $_$
1546
SELECT util.eval($$ALTER TABLE $$||$1.table_||$$ DROP COLUMN IF EXISTS $$||
1547
quote_ident($1.name)||util._if($2, $$ CASCADE$$, ''::text))
1548
$_$;
1549

    
1550

    
1551
--
1552
-- Name: FUNCTION drop_column(col col_ref, force boolean); Type: COMMENT; Schema: util; Owner: -
1553
--
1554

    
1555
COMMENT ON FUNCTION drop_column(col col_ref, force boolean) IS '
1556
idempotent
1557
';
1558

    
1559

    
1560
--
1561
-- Name: drop_column(regclass[], text, boolean); Type: FUNCTION; Schema: util; Owner: -
1562
--
1563

    
1564
CREATE FUNCTION drop_column(tables regclass[], col text, force boolean DEFAULT false) RETURNS void
1565
    LANGUAGE sql
1566
    AS $_$
1567
SELECT util.drop_column((table_, $2), $3) FROM unnest($1) table_;
1568
SELECT NULL::void; -- don't fold away functions called in previous query
1569
$_$;
1570

    
1571

    
1572
--
1573
-- Name: FUNCTION drop_column(tables regclass[], col text, force boolean); Type: COMMENT; Schema: util; Owner: -
1574
--
1575

    
1576
COMMENT ON FUNCTION drop_column(tables regclass[], col text, force boolean) IS '
1577
idempotent
1578
';
1579

    
1580

    
1581
--
1582
-- Name: drop_relation(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1583
--
1584

    
1585
CREATE FUNCTION drop_relation(relation anyelement, force boolean DEFAULT false) RETURNS void
1586
    LANGUAGE sql
1587
    AS $_$
1588
/* use util.qual_name() instead of ::text so that the schema qualifier is always
1589
included in the debug SQL */
1590
SELECT util.drop_relation(util.relation_type($1), util.qual_name($1), $2)
1591
$_$;
1592

    
1593

    
1594
--
1595
-- Name: drop_relation(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1596
--
1597

    
1598
CREATE FUNCTION drop_relation(type text, relation_esc text, force boolean DEFAULT false) RETURNS void
1599
    LANGUAGE sql
1600
    AS $_$
1601
SELECT util.eval($$DROP $$||$1||$$ IF EXISTS $$||$2
1602
||util._if($3, $$ CASCADE$$, ''::text))
1603
$_$;
1604

    
1605

    
1606
--
1607
-- Name: FUNCTION drop_relation(type text, relation_esc text, force boolean); Type: COMMENT; Schema: util; Owner: -
1608
--
1609

    
1610
COMMENT ON FUNCTION drop_relation(type text, relation_esc text, force boolean) IS '
1611
idempotent
1612
';
1613

    
1614

    
1615
--
1616
-- Name: drop_relations_like(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1617
--
1618

    
1619
CREATE FUNCTION drop_relations_like(name_regexp text, schema_anchor anyelement, force boolean DEFAULT false) RETURNS void
1620
    LANGUAGE sql
1621
    AS $_$
1622
SELECT util.drop_relations_like($1, util.schema_regexp($2), $3)
1623
$_$;
1624

    
1625

    
1626
--
1627
-- Name: drop_relations_like(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1628
--
1629

    
1630
CREATE FUNCTION drop_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, force boolean DEFAULT false) RETURNS void
1631
    LANGUAGE sql
1632
    AS $_$
1633
SELECT util.debug_print_func_call(util.quote_func_call(
1634
'util.drop_relations_like', util.quote_typed($1), util.quote_typed($2),
1635
util.quote_typed($3)))
1636
;
1637
SELECT util.drop_relation(relation, $3)
1638
FROM util.show_relations_like($1, $2) relation
1639
;
1640
SELECT NULL::void; -- don't fold away functions called in previous query
1641
$_$;
1642

    
1643

    
1644
--
1645
-- Name: drop_table(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1646
--
1647

    
1648
CREATE FUNCTION drop_table(table_ text, force boolean DEFAULT false) RETURNS void
1649
    LANGUAGE sql
1650
    AS $_$
1651
SELECT util.drop_relation('TABLE', $1, $2)
1652
$_$;
1653

    
1654

    
1655
--
1656
-- Name: FUNCTION drop_table(table_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1657
--
1658

    
1659
COMMENT ON FUNCTION drop_table(table_ text, force boolean) IS '
1660
idempotent
1661
';
1662

    
1663

    
1664
--
1665
-- Name: drop_view(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1666
--
1667

    
1668
CREATE FUNCTION drop_view(view_ text, force boolean DEFAULT false) RETURNS void
1669
    LANGUAGE sql
1670
    AS $_$
1671
SELECT util.drop_relation('VIEW', $1, $2)
1672
$_$;
1673

    
1674

    
1675
--
1676
-- Name: FUNCTION drop_view(view_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1677
--
1678

    
1679
COMMENT ON FUNCTION drop_view(view_ text, force boolean) IS '
1680
idempotent
1681
';
1682

    
1683

    
1684
--
1685
-- Name: empty_array(anyelement); Type: FUNCTION; Schema: util; Owner: -
1686
--
1687

    
1688
CREATE FUNCTION empty_array(elem_type_null anyelement DEFAULT NULL::text) RETURNS anyarray
1689
    LANGUAGE sql IMMUTABLE
1690
    AS $_$
1691
SELECT util.array_fill($1, 0)
1692
$_$;
1693

    
1694

    
1695
--
1696
-- Name: FUNCTION empty_array(elem_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1697
--
1698

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

    
1703

    
1704
--
1705
-- Name: ensure_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1706
--
1707

    
1708
CREATE FUNCTION ensure_prefix(prefix text, str text) RETURNS text
1709
    LANGUAGE sql IMMUTABLE
1710
    AS $_$
1711
SELECT (CASE WHEN util.has_prefix($1, $2) THEN $2 ELSE $1||$2 END)
1712
$_$;
1713

    
1714

    
1715
--
1716
-- Name: esc_name__append(text, text); Type: FUNCTION; Schema: util; Owner: -
1717
--
1718

    
1719
CREATE FUNCTION esc_name__append(suffix text, esc_name text) RETURNS text
1720
    LANGUAGE sql IMMUTABLE
1721
    AS $_$
1722
SELECT regexp_replace($2, '("?)$', $1||'\1')
1723
$_$;
1724

    
1725

    
1726
--
1727
-- Name: eval(text[]); Type: FUNCTION; Schema: util; Owner: -
1728
--
1729

    
1730
CREATE FUNCTION eval(queries text[]) RETURNS void
1731
    LANGUAGE sql
1732
    AS $_$
1733
SELECT util.eval(query) FROM unnest($1) query;
1734
SELECT NULL::void; -- don't fold away functions called in previous query
1735
$_$;
1736

    
1737

    
1738
--
1739
-- Name: eval(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1740
--
1741

    
1742
CREATE FUNCTION eval(sql text, verbose_ boolean DEFAULT true) RETURNS void
1743
    LANGUAGE plpgsql
1744
    AS $$
1745
BEGIN
1746
	sql = util.view_def_to_orig(sql); -- restore user's intent
1747
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1748
	EXECUTE sql;
1749
END;
1750
$$;
1751

    
1752

    
1753
--
1754
-- Name: eval2col_pair(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1755
--
1756

    
1757
CREATE FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1758
    LANGUAGE plpgsql
1759
    AS $$
1760
BEGIN
1761
	PERFORM util.debug_print_sql(sql);
1762
	RETURN QUERY EXECUTE sql;
1763
END;
1764
$$;
1765

    
1766

    
1767
--
1768
-- Name: FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1769
--
1770

    
1771
COMMENT ON FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1772
col_type_null (*required*): NULL::col_type
1773
';
1774

    
1775

    
1776
--
1777
-- Name: eval2records(text); Type: FUNCTION; Schema: util; Owner: -
1778
--
1779

    
1780
CREATE FUNCTION eval2records(sql text) RETURNS SETOF record
1781
    LANGUAGE plpgsql
1782
    AS $$
1783
BEGIN
1784
	PERFORM util.debug_print_sql(sql);
1785
	RETURN QUERY EXECUTE sql;
1786
END;
1787
$$;
1788

    
1789

    
1790
--
1791
-- Name: eval2set(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1792
--
1793

    
1794
CREATE FUNCTION eval2set(sql text, ret_type_null anyelement DEFAULT NULL::text, verbose_ boolean DEFAULT true) RETURNS SETOF anyelement
1795
    LANGUAGE plpgsql
1796
    AS $$
1797
BEGIN
1798
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1799
	RETURN QUERY EXECUTE sql;
1800
END;
1801
$$;
1802

    
1803

    
1804
--
1805
-- Name: eval2val(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1806
--
1807

    
1808
CREATE FUNCTION eval2val(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1809
    LANGUAGE plpgsql STABLE
1810
    AS $$
1811
DECLARE
1812
	ret_val ret_type_null%TYPE;
1813
BEGIN
1814
	PERFORM util.debug_print_sql(sql);
1815
	EXECUTE sql INTO STRICT ret_val;
1816
	RETURN ret_val;
1817
END;
1818
$$;
1819

    
1820

    
1821
--
1822
-- Name: FUNCTION eval2val(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1823
--
1824

    
1825
COMMENT ON FUNCTION eval2val(sql text, ret_type_null anyelement) IS '
1826
ret_type_null: NULL::ret_type
1827
';
1828

    
1829

    
1830
--
1831
-- Name: eval_expr(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1832
--
1833

    
1834
CREATE FUNCTION eval_expr(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1835
    LANGUAGE sql
1836
    AS $_$
1837
SELECT util.eval2val($$SELECT $$||$1, $2)
1838
$_$;
1839

    
1840

    
1841
--
1842
-- Name: FUNCTION eval_expr(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1843
--
1844

    
1845
COMMENT ON FUNCTION eval_expr(sql text, ret_type_null anyelement) IS '
1846
ret_type_null: NULL::ret_type
1847
';
1848

    
1849

    
1850
--
1851
-- Name: eval_expr_passthru(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1852
--
1853

    
1854
CREATE FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1855
    LANGUAGE sql
1856
    AS $_$
1857
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE util.eval_expr($1, $2) END
1858
$_$;
1859

    
1860

    
1861
--
1862
-- Name: FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1863
--
1864

    
1865
COMMENT ON FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement) IS '
1866
sql: can be NULL, which will be passed through
1867
ret_type_null: NULL::ret_type
1868
';
1869

    
1870

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

    
1875
CREATE FUNCTION existing_cols(table_ regclass, VARIADIC col_names text[]) RETURNS SETOF text
1876
    LANGUAGE sql STABLE
1877
    AS $_$
1878
SELECT col_name
1879
FROM unnest($2) s (col_name)
1880
WHERE util.col_exists(($1, col_name))
1881
$_$;
1882

    
1883

    
1884
--
1885
-- Name: explain(text); Type: FUNCTION; Schema: util; Owner: -
1886
--
1887

    
1888
CREATE FUNCTION explain(sql text) RETURNS SETOF text
1889
    LANGUAGE sql
1890
    SET client_min_messages TO 'error'
1891
    AS $_$
1892
/* `client_min_messages = ERROR`: EXPLAIN apparently runs IMMUTABLE functions in
1893
the query, so this prevents displaying any log messages printed by them */
1894
SELECT util.eval2set($$EXPLAIN $$||$1, verbose_ := false)
1895
$_$;
1896

    
1897

    
1898
--
1899
-- Name: explain2notice(text); Type: FUNCTION; Schema: util; Owner: -
1900
--
1901

    
1902
CREATE FUNCTION explain2notice(sql text) RETURNS void
1903
    LANGUAGE sql
1904
    AS $_$
1905
SELECT util.raise('NOTICE', util.explain2notice_msg($1))
1906
$_$;
1907

    
1908

    
1909
--
1910
-- Name: explain2notice_msg(text); Type: FUNCTION; Schema: util; Owner: -
1911
--
1912

    
1913
CREATE FUNCTION explain2notice_msg(sql text) RETURNS text
1914
    LANGUAGE sql
1915
    AS $_$
1916
-- newline before and after to visually separate it from other debug info
1917
SELECT COALESCE($$
1918
EXPLAIN:
1919
$$||util.fold_explain_msg(util.explain2str($1))||$$
1920
$$, '')
1921
$_$;
1922

    
1923

    
1924
--
1925
-- Name: explain2notice_msg_if_can(text); Type: FUNCTION; Schema: util; Owner: -
1926
--
1927

    
1928
CREATE FUNCTION explain2notice_msg_if_can(sql text) RETURNS text
1929
    LANGUAGE plpgsql
1930
    AS $$
1931
BEGIN
1932
	RETURN util.explain2notice_msg(sql);
1933
EXCEPTION
1934
WHEN   syntax_error
1935
	OR invalid_cursor_definition -- "cannot open multi-query plan as cursor"
1936
	THEN RETURN NULL; -- non-explainable query
1937
	/* don't use util.is_explainable() because the list provided by Postgres
1938
	(http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691)
1939
	excludes some query types that are in fact EXPLAIN-able */
1940
END;
1941
$$;
1942

    
1943

    
1944
--
1945
-- Name: explain2str(text); Type: FUNCTION; Schema: util; Owner: -
1946
--
1947

    
1948
CREATE FUNCTION explain2str(sql text) RETURNS text
1949
    LANGUAGE sql
1950
    AS $_$
1951
SELECT util.join_strs(explain, $$
1952
$$) FROM util.explain($1)
1953
$_$;
1954

    
1955

    
1956
SET default_tablespace = '';
1957

    
1958
SET default_with_oids = false;
1959

    
1960
--
1961
-- Name: explain; Type: TABLE; Schema: util; Owner: -; Tablespace: 
1962
--
1963

    
1964
CREATE TABLE explain (
1965
    line text NOT NULL
1966
);
1967

    
1968

    
1969
--
1970
-- Name: explain2table(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1971
--
1972

    
1973
CREATE FUNCTION explain2table(sql text, table_ regclass DEFAULT 'explain'::regclass) RETURNS void
1974
    LANGUAGE sql
1975
    AS $_$
1976
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT util.explain(
1977
$$||quote_nullable($1)||$$
1978
)$$)
1979
$_$;
1980

    
1981

    
1982
--
1983
-- Name: FUNCTION explain2table(sql text, table_ regclass); Type: COMMENT; Schema: util; Owner: -
1984
--
1985

    
1986
COMMENT ON FUNCTION explain2table(sql text, table_ regclass) IS '
1987
usage:
1988
PERFORM util.explain2table($$
1989
query
1990
$$);
1991
';
1992

    
1993

    
1994
--
1995
-- Name: first_word(text); Type: FUNCTION; Schema: util; Owner: -
1996
--
1997

    
1998
CREATE FUNCTION first_word(str text) RETURNS text
1999
    LANGUAGE sql IMMUTABLE
2000
    AS $_$
2001
SELECT match[1] FROM regexp_matches(util.ltrim_nl($1), '^(\S*)') match
2002
$_$;
2003

    
2004

    
2005
--
2006
-- Name: fix_array(anyarray); Type: FUNCTION; Schema: util; Owner: -
2007
--
2008

    
2009
CREATE FUNCTION fix_array("array" anyarray) RETURNS anyarray
2010
    LANGUAGE sql IMMUTABLE
2011
    AS $_$
2012
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE (
2013
	CASE WHEN pg_catalog.array_ndims($1) IS NULL THEN util.empty_array($1[1]) ELSE $1 END
2014
) END
2015
$_$;
2016

    
2017

    
2018
--
2019
-- Name: FUNCTION fix_array("array" anyarray); Type: COMMENT; Schema: util; Owner: -
2020
--
2021

    
2022
COMMENT ON FUNCTION fix_array("array" anyarray) IS '
2023
ensures that an array will always have proper non-NULL dimensions
2024
';
2025

    
2026

    
2027
--
2028
-- Name: fold_explain_msg(text); Type: FUNCTION; Schema: util; Owner: -
2029
--
2030

    
2031
CREATE FUNCTION fold_explain_msg(explain text) RETURNS text
2032
    LANGUAGE sql IMMUTABLE
2033
    AS $_$
2034
SELECT (CASE WHEN util.first_word($1) = 'Result' THEN NULL ELSE $1 END)
2035
$_$;
2036

    
2037

    
2038
--
2039
-- Name: force_update_view(text, text); Type: FUNCTION; Schema: util; Owner: -
2040
--
2041

    
2042
CREATE FUNCTION force_update_view(view_ text, query text) RETURNS void
2043
    LANGUAGE plpgsql STRICT
2044
    AS $_$
2045
DECLARE
2046
	mk_view text = $$CREATE OR REPLACE VIEW $$||view_||$$ AS
2047
$$||query;
2048
BEGIN
2049
	EXECUTE mk_view;
2050
EXCEPTION
2051
WHEN invalid_table_definition THEN
2052
	IF SQLERRM = 'cannot drop columns from view'
2053
	OR SQLERRM LIKE 'cannot change name of view column "%" to "%"'
2054
	THEN
2055
		EXECUTE $$DROP VIEW $$||view_||$$ CASCADE$$;
2056
		EXECUTE mk_view;
2057
	ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM;
2058
	END IF;
2059
END;
2060
$_$;
2061

    
2062

    
2063
--
2064
-- Name: FUNCTION force_update_view(view_ text, query text); Type: COMMENT; Schema: util; Owner: -
2065
--
2066

    
2067
COMMENT ON FUNCTION force_update_view(view_ text, query text) IS '
2068
idempotent
2069
';
2070

    
2071

    
2072
--
2073
-- Name: freq_always_1(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2074
--
2075

    
2076
CREATE FUNCTION freq_always_1(table_ regclass, freq_col text DEFAULT 'copies'::text) RETURNS boolean
2077
    LANGUAGE sql STABLE
2078
    AS $_$
2079
SELECT util.eval2val(
2080
$$SELECT NOT EXISTS( -- there is no row that is != 1
2081
	SELECT NULL
2082
	FROM $$||$1||$$
2083
	WHERE $$||quote_ident(freq_col)||$$ IS DISTINCT FROM 1
2084
	LIMIT 1
2085
)
2086
$$, NULL::boolean)
2087
$_$;
2088

    
2089

    
2090
--
2091
-- Name: freq_always_1(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
2092
--
2093

    
2094
CREATE FUNCTION freq_always_1(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS boolean
2095
    LANGUAGE sql STABLE
2096
    AS $_$
2097
SELECT bool_and(util.freq_always_1(table_, $2)) FROM unnest($1) table_
2098
$_$;
2099

    
2100

    
2101
--
2102
-- Name: geometry(geocoord); Type: FUNCTION; Schema: util; Owner: -
2103
--
2104

    
2105
CREATE FUNCTION geometry(geocoord geocoord) RETURNS postgis.geometry
2106
    LANGUAGE sql IMMUTABLE
2107
    SET client_min_messages TO 'warning'
2108
    AS $_$
2109
SELECT postgis.st_setsrid(postgis.st_point(
2110
/*x_lon=*/$1.longitude_deg, /*y_lat=*/$1.latitude_deg),
2111
/*WGS84*/4326)
2112
$_$;
2113

    
2114

    
2115
--
2116
-- Name: FUNCTION geometry(geocoord geocoord); Type: COMMENT; Schema: util; Owner: -
2117
--
2118

    
2119
COMMENT ON FUNCTION geometry(geocoord geocoord) IS '
2120
*note*: it is not possible to create a cast for this, as a bug in pg_dump
2121
prevents the cast from being exported, even when no export filters are applied
2122
';
2123

    
2124

    
2125
--
2126
-- Name: grants_users(); Type: FUNCTION; Schema: util; Owner: -
2127
--
2128

    
2129
CREATE FUNCTION grants_users() RETURNS SETOF text
2130
    LANGUAGE sql IMMUTABLE
2131
    AS $$
2132
VALUES ('bien_read'), ('public_')
2133
$$;
2134

    
2135

    
2136
--
2137
-- Name: has_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
2138
--
2139

    
2140
CREATE FUNCTION has_prefix(prefix text, str text) RETURNS boolean
2141
    LANGUAGE sql IMMUTABLE
2142
    AS $_$
2143
SELECT substring($2 for length($1)) = $1
2144
$_$;
2145

    
2146

    
2147
--
2148
-- Name: has_single_row(regclass); Type: FUNCTION; Schema: util; Owner: -
2149
--
2150

    
2151
CREATE FUNCTION has_single_row(table_ regclass) RETURNS boolean
2152
    LANGUAGE sql STABLE
2153
    AS $_$
2154
SELECT util.eval2val($$SELECT COUNT(*) = 1 FROM $$||$1, NULL::boolean)
2155
$_$;
2156

    
2157

    
2158
--
2159
-- Name: hstore(text[], text); Type: FUNCTION; Schema: util; Owner: -
2160
--
2161

    
2162
CREATE FUNCTION hstore(keys text[], value text) RETURNS hstore
2163
    LANGUAGE sql IMMUTABLE
2164
    AS $_$
2165
SELECT hstore(util.fix_array($1), util.array_fill($2, util.array_length($1)))
2166
$_$;
2167

    
2168

    
2169
--
2170
-- Name: FUNCTION hstore(keys text[], value text); Type: COMMENT; Schema: util; Owner: -
2171
--
2172

    
2173
COMMENT ON FUNCTION hstore(keys text[], value text) IS '
2174
avoids repeating the same value for each key
2175
';
2176

    
2177

    
2178
--
2179
-- Name: ifnull(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2180
--
2181

    
2182
CREATE FUNCTION ifnull(value anyelement, null_ anyelement) RETURNS anyelement
2183
    LANGUAGE sql IMMUTABLE
2184
    AS $_$
2185
SELECT COALESCE($1, $2)
2186
$_$;
2187

    
2188

    
2189
--
2190
-- Name: FUNCTION ifnull(value anyelement, null_ anyelement); Type: COMMENT; Schema: util; Owner: -
2191
--
2192

    
2193
COMMENT ON FUNCTION ifnull(value anyelement, null_ anyelement) IS '
2194
equivalent to MySQL''s IFNULL() (Postgres auto-lowercases the name)
2195
';
2196

    
2197

    
2198
--
2199
-- Name: in_new_world(geocoord); Type: FUNCTION; Schema: util; Owner: -
2200
--
2201

    
2202
CREATE FUNCTION in_new_world(point geocoord) RETURNS boolean
2203
    LANGUAGE sql IMMUTABLE
2204
    AS $_$
2205
/* use function rather than operator+search_path to allow inlining, which
2206
enables util.new_world() to only be evaluated once */
2207
SELECT util.contained_within_approx($1, util.new_world())
2208
$_$;
2209

    
2210

    
2211
--
2212
-- Name: FUNCTION in_new_world(point geocoord); Type: COMMENT; Schema: util; Owner: -
2213
--
2214

    
2215
COMMENT ON FUNCTION in_new_world(point geocoord) IS '
2216
**WARNING**: this includes false positives above and below the New World
2217
bounding box, as described in util.bounding_box()
2218
';
2219

    
2220

    
2221
--
2222
-- Name: in_reverse(anyarray); Type: FUNCTION; Schema: util; Owner: -
2223
--
2224

    
2225
CREATE FUNCTION in_reverse("array" anyarray) RETURNS SETOF anyelement
2226
    LANGUAGE sql IMMUTABLE
2227
    AS $_$
2228
SELECT elem FROM unnest($1) elem ORDER BY row_number() OVER () DESC
2229
$_$;
2230

    
2231

    
2232
--
2233
-- Name: in_south_america(geocoord); Type: FUNCTION; Schema: util; Owner: -
2234
--
2235

    
2236
CREATE FUNCTION in_south_america(point geocoord) RETURNS boolean
2237
    LANGUAGE sql IMMUTABLE
2238
    AS $_$
2239
/* use function rather than operator+search_path to allow inlining, which
2240
enables util.south_america() to only be evaluated once */
2241
SELECT $1.latitude_deg BETWEEN -56 AND 13 AND $1.longitude_deg BETWEEN -82 AND -34
2242
$_$;
2243

    
2244

    
2245
--
2246
-- Name: inherit(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
2247
--
2248

    
2249
CREATE FUNCTION inherit(derived regclass, base regclass) RETURNS void
2250
    LANGUAGE sql
2251
    AS $_$
2252
SELECT util.eval($$ALTER TABLE $$||$1||$$ INHERIT $$||$2)
2253
$_$;
2254

    
2255

    
2256
--
2257
-- Name: is_castable(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
2258
--
2259

    
2260
CREATE FUNCTION is_castable(value text, ret_type_null anyelement) RETURNS boolean
2261
    LANGUAGE plpgsql IMMUTABLE
2262
    AS $$
2263
BEGIN
2264
	PERFORM util.cast(value, ret_type_null);
2265
	-- must happen *after* cast check, because NULL is not valid for some types
2266
	IF value IS NULL THEN RETURN NULL; END IF; -- pass NULL through
2267
	RETURN true;
2268
EXCEPTION
2269
WHEN   data_exception
2270
	OR invalid_schema_name -- eg. 'pg_temp.__'::regclass
2271
	OR syntax_error_or_access_rule_violation -- eg. ::regclass
2272
	THEN
2273
	RETURN false;
2274
END;
2275
$$;
2276

    
2277

    
2278
--
2279
-- Name: FUNCTION is_castable(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
2280
--
2281

    
2282
COMMENT ON FUNCTION is_castable(value text, ret_type_null anyelement) IS '
2283
passes NULL through. however, if NULL is not valid for the type, false will be
2284
returned instead.
2285

    
2286
ret_type_null: NULL::ret_type
2287
';
2288

    
2289

    
2290
--
2291
-- Name: is_constant(col_ref); Type: FUNCTION; Schema: util; Owner: -
2292
--
2293

    
2294
CREATE FUNCTION is_constant(col col_ref) RETURNS boolean
2295
    LANGUAGE sql STABLE
2296
    AS $_$
2297
SELECT COALESCE(util.col_comment($1) LIKE '
2298
constant
2299
%', false)
2300
$_$;
2301

    
2302

    
2303
--
2304
-- Name: is_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2305
--
2306

    
2307
CREATE FUNCTION is_empty("array" anyarray) RETURNS boolean
2308
    LANGUAGE sql IMMUTABLE
2309
    AS $_$
2310
SELECT util.array_length($1) = 0
2311
$_$;
2312

    
2313

    
2314
--
2315
-- Name: is_explain(text); Type: FUNCTION; Schema: util; Owner: -
2316
--
2317

    
2318
CREATE FUNCTION is_explain(sql text) RETURNS boolean
2319
    LANGUAGE sql IMMUTABLE
2320
    AS $_$
2321
SELECT upper(util.first_word($1)) = 'EXPLAIN'
2322
$_$;
2323

    
2324

    
2325
--
2326
-- Name: is_explainable(text); Type: FUNCTION; Schema: util; Owner: -
2327
--
2328

    
2329
CREATE FUNCTION is_explainable(sql text) RETURNS boolean
2330
    LANGUAGE sql IMMUTABLE
2331
    AS $_$
2332
SELECT upper(util.first_word($1)) = ANY(
2333
'{SELECT,INSERT,UPDATE,DELETE,VALUES,EXECUTE,DECLARE}'::text[]
2334
/*from http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691*/
2335
)
2336
$_$;
2337

    
2338

    
2339
--
2340
-- Name: is_more_complete_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2341
--
2342

    
2343
CREATE FUNCTION is_more_complete_than("left" anyelement, "right" anyelement) RETURNS boolean
2344
    LANGUAGE sql IMMUTABLE
2345
    AS $_$
2346
SELECT $1 IS NOT DISTINCT FROM $2 OR ($1 IS NOT NULL AND $2 IS NULL)
2347
$_$;
2348

    
2349

    
2350
--
2351
-- Name: is_populated_more_often_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2352
--
2353

    
2354
CREATE FUNCTION is_populated_more_often_than("left" anyelement, "right" anyelement) RETURNS boolean
2355
    LANGUAGE sql IMMUTABLE
2356
    AS $_$
2357
SELECT $1 IS NOT NULL >= $2 IS NOT NULL -- true > false
2358
$_$;
2359

    
2360

    
2361
--
2362
-- Name: is_set_stmt(text); Type: FUNCTION; Schema: util; Owner: -
2363
--
2364

    
2365
CREATE FUNCTION is_set_stmt(sql text) RETURNS boolean
2366
    LANGUAGE sql IMMUTABLE
2367
    AS $_$
2368
SELECT upper(util.first_word($1)) = 'SET'
2369
$_$;
2370

    
2371

    
2372
--
2373
-- Name: is_table(regclass); Type: FUNCTION; Schema: util; Owner: -
2374
--
2375

    
2376
CREATE FUNCTION is_table(relation regclass) RETURNS boolean
2377
    LANGUAGE sql STABLE
2378
    AS $_$
2379
SELECT relkind = 'r' FROM pg_class WHERE oid = $1
2380
$_$;
2381

    
2382

    
2383
--
2384
-- Name: is_view(regclass); Type: FUNCTION; Schema: util; Owner: -
2385
--
2386

    
2387
CREATE FUNCTION is_view(relation regclass) RETURNS boolean
2388
    LANGUAGE sql STABLE
2389
    AS $_$
2390
SELECT relkind = 'v' FROM pg_class WHERE oid = $1
2391
$_$;
2392

    
2393

    
2394
--
2395
-- Name: join_strs_transform(text, text, text); Type: FUNCTION; Schema: util; Owner: -
2396
--
2397

    
2398
CREATE FUNCTION join_strs_transform(state text, value text, delim text) RETURNS text
2399
    LANGUAGE sql IMMUTABLE STRICT
2400
    AS $_$
2401
SELECT $1 || $3 || $2
2402
$_$;
2403

    
2404

    
2405
--
2406
-- Name: FUNCTION join_strs_transform(state text, value text, delim text); Type: COMMENT; Schema: util; Owner: -
2407
--
2408

    
2409
COMMENT ON FUNCTION join_strs_transform(state text, value text, delim text) IS '
2410
must be declared STRICT to use the special handling of STRICT aggregating functions
2411
';
2412

    
2413

    
2414
--
2415
-- Name: keys(anyelement); Type: FUNCTION; Schema: util; Owner: -
2416
--
2417

    
2418
CREATE FUNCTION keys(value anyelement) RETURNS anyelement
2419
    LANGUAGE sql IMMUTABLE
2420
    AS $_$
2421
SELECT $1 -- compare on the entire value
2422
$_$;
2423

    
2424

    
2425
--
2426
-- Name: keys_eq(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
2427
--
2428

    
2429
CREATE FUNCTION keys_eq(left_ anyelement, right_ anyelement) RETURNS boolean
2430
    LANGUAGE sql STABLE
2431
    AS $_$
2432
SELECT keys($1) = keys($2)
2433
$_$;
2434

    
2435

    
2436
--
2437
-- Name: FUNCTION keys_eq(left_ anyelement, right_ anyelement); Type: COMMENT; Schema: util; Owner: -
2438
--
2439

    
2440
COMMENT ON FUNCTION keys_eq(left_ anyelement, right_ anyelement) IS '
2441
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**)
2442
';
2443

    
2444

    
2445
--
2446
-- Name: limit2row_num(integer, integer, integer); Type: FUNCTION; Schema: util; Owner: -
2447
--
2448

    
2449
CREATE FUNCTION limit2row_num(limit_ integer, offset_ integer DEFAULT NULL::integer, min_row_num integer DEFAULT 1) RETURNS integer
2450
    LANGUAGE sql IMMUTABLE
2451
    AS $_$
2452
SELECT COALESCE(util.offset2row_num($2, $3) + $1 - 1, 2147483647)
2453
$_$;
2454

    
2455

    
2456
--
2457
-- Name: loop_ignore_errors(text, text, anyelement); Type: FUNCTION; Schema: util; Owner: -
2458
--
2459

    
2460
CREATE FUNCTION loop_ignore_errors(iter_sql text, loop_body_sql text, loop_type_null anyelement DEFAULT NULL::text) RETURNS void
2461
    LANGUAGE plpgsql
2462
    AS $$
2463
DECLARE
2464
	errors_ct integer = 0;
2465
	loop_var loop_type_null%TYPE;
2466
BEGIN
2467
	FOR loop_var IN SELECT * FROM util.eval2set(iter_sql, loop_type_null)
2468
	LOOP
2469
		BEGIN
2470
			EXECUTE loop_body_sql USING loop_var;
2471
		EXCEPTION
2472
		WHEN OTHERS THEN
2473
			errors_ct = errors_ct+1;
2474
			PERFORM util.raise_error_warning(SQLERRM);
2475
		END;
2476
	END LOOP;
2477
	IF errors_ct > 0 THEN
2478
		-- can't raise exception because this would roll back the transaction
2479
		PERFORM util.raise_error_warning('there were '||errors_ct
2480
			||' errors: see the WARNINGs for details');
2481
	END IF;
2482
END;
2483
$$;
2484

    
2485

    
2486
--
2487
-- Name: ltrim_nl(text); Type: FUNCTION; Schema: util; Owner: -
2488
--
2489

    
2490
CREATE FUNCTION ltrim_nl(str text) RETURNS text
2491
    LANGUAGE sql IMMUTABLE
2492
    AS $_$
2493
SELECT ltrim($1, $$
2494
$$)
2495
$_$;
2496

    
2497

    
2498
--
2499
-- Name: map_filter_insert(); Type: FUNCTION; Schema: util; Owner: -
2500
--
2501

    
2502
CREATE FUNCTION map_filter_insert() RETURNS trigger
2503
    LANGUAGE plpgsql
2504
    AS $$
2505
BEGIN
2506
	IF new."from" LIKE ':%' THEN RETURN NULL; END IF; -- exclude metadata values
2507
	RETURN new;
2508
END;
2509
$$;
2510

    
2511

    
2512
--
2513
-- Name: map_get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2514
--
2515

    
2516
CREATE FUNCTION map_get(map regclass, key text) RETURNS text
2517
    LANGUAGE plpgsql STABLE STRICT
2518
    AS $_$
2519
DECLARE
2520
    value text;
2521
BEGIN
2522
    EXECUTE $$SELECT "to" FROM $$||map||$$ WHERE "from" = $1$$
2523
        INTO value USING key;
2524
    RETURN value;
2525
END;
2526
$_$;
2527

    
2528

    
2529
--
2530
-- Name: map_nulls(text[], anyelement); Type: FUNCTION; Schema: util; Owner: -
2531
--
2532

    
2533
CREATE FUNCTION map_nulls(nulls text[], value anyelement) RETURNS anyelement
2534
    LANGUAGE sql IMMUTABLE
2535
    AS $_$
2536
SELECT util._map(util.nulls_map($1), $2)
2537
$_$;
2538

    
2539

    
2540
--
2541
-- Name: FUNCTION map_nulls(nulls text[], value anyelement); Type: COMMENT; Schema: util; Owner: -
2542
--
2543

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

    
2547
[1] inlining of function calls, which is different from constant folding
2548
[2] _map()''s profiling query
2549
SELECT util._map(''"1"=>NULL, "2"=>NULL, "3"=>NULL, *=>*'', v) FROM unnest(array_fill(1, array[100000])) f (v)
2550
and map_nulls()''s profiling query
2551
SELECT util.map_nulls(array[1, 2, 3]::text[], v) FROM unnest(array_fill(1, array[100000])) f (v)
2552
both take ~920 ms.
2553
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.
2554
';
2555

    
2556

    
2557
--
2558
-- Name: map_values(regclass); Type: FUNCTION; Schema: util; Owner: -
2559
--
2560

    
2561
CREATE FUNCTION map_values(map regclass) RETURNS SETOF text
2562
    LANGUAGE plpgsql STABLE STRICT
2563
    AS $_$
2564
BEGIN
2565
    RETURN QUERY EXECUTE $$SELECT "to" FROM $$||map;
2566
END;
2567
$_$;
2568

    
2569

    
2570
--
2571
-- Name: materialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2572
--
2573

    
2574
CREATE FUNCTION materialize_query(table_esc text, sql text) RETURNS void
2575
    LANGUAGE sql
2576
    AS $_$
2577
SELECT util.create_if_not_exists($$CREATE TABLE $$||$1||$$ AS
2578
$$||util.ltrim_nl($2));
2579
-- make sure the created table has the correct estimated row count
2580
SELECT util.analyze_($1);
2581

    
2582
SELECT util.append_comment($1, '
2583
contents generated from:
2584
'||util.ltrim_nl(util.runnable_sql($2))||';
2585
');
2586
$_$;
2587

    
2588

    
2589
--
2590
-- Name: FUNCTION materialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2591
--
2592

    
2593
COMMENT ON FUNCTION materialize_query(table_esc text, sql text) IS '
2594
idempotent
2595
';
2596

    
2597

    
2598
--
2599
-- Name: materialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2600
--
2601

    
2602
CREATE FUNCTION materialize_view(table_esc text, view_ regclass) RETURNS void
2603
    LANGUAGE sql
2604
    AS $_$
2605
SELECT util.create_if_not_exists($$
2606
SELECT util.copy($$||util.quote_typed($2)||$$, $$||util.quote_typed($1)||$$)
2607
$$);
2608
$_$;
2609

    
2610

    
2611
--
2612
-- Name: FUNCTION materialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2613
--
2614

    
2615
COMMENT ON FUNCTION materialize_view(table_esc text, view_ regclass) IS '
2616
idempotent
2617
';
2618

    
2619

    
2620
--
2621
-- Name: mk_const_col(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
2622
--
2623

    
2624
CREATE FUNCTION mk_const_col(col col_ref, value anyelement) RETURNS void
2625
    LANGUAGE sql
2626
    AS $_$
2627
SELECT util.create_if_not_exists($$
2628
ALTER TABLE $$||$1.table_||$$ ADD COLUMN $$
2629
||quote_ident($1.name)||$$ $$||pg_typeof($2)||util.type_qual($2)||$$ DEFAULT $$
2630
||quote_literal($2)||$$;
2631
COMMENT ON COLUMN $$||$1.table_||$$.$$||quote_ident($1.name)||$$ IS '
2632
constant
2633
';
2634
$$)
2635
$_$;
2636

    
2637

    
2638
--
2639
-- Name: FUNCTION mk_const_col(col col_ref, value anyelement); Type: COMMENT; Schema: util; Owner: -
2640
--
2641

    
2642
COMMENT ON FUNCTION mk_const_col(col col_ref, value anyelement) IS '
2643
idempotent
2644
';
2645

    
2646

    
2647
--
2648
-- Name: mk_derived_col(col_ref, text, boolean); Type: FUNCTION; Schema: util; Owner: -
2649
--
2650

    
2651
CREATE FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean DEFAULT false) RETURNS void
2652
    LANGUAGE plpgsql STRICT
2653
    AS $_$
2654
DECLARE
2655
    type regtype = util.typeof(expr, col.table_::text::regtype);
2656
    col_name_sql text = quote_ident(col.name);
2657
BEGIN
2658
    PERFORM util.create_if_not_exists((CASE WHEN overwrite THEN '' ELSE $$
2659
ALTER TABLE $$||col.table_||$$ ADD   COLUMN $$||col_name_sql||$$      $$||type||$$;$$ END)||$$
2660
ALTER TABLE $$||col.table_||$$ ALTER COLUMN $$||col_name_sql||$$ TYPE $$||type||$$ USING
2661
$$||expr||$$;
2662
$$);
2663
END;
2664
$_$;
2665

    
2666

    
2667
--
2668
-- Name: FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean); Type: COMMENT; Schema: util; Owner: -
2669
--
2670

    
2671
COMMENT ON FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean) IS '
2672
idempotent
2673
';
2674

    
2675

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

    
2680
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
2681
    LANGUAGE sql IMMUTABLE
2682
    AS $_$
2683
SELECT
2684
$$SELECT
2685
$$||$3||$$
2686
FROM      $$||$1||$$ left_
2687
FULL JOIN $$||$2||$$ right_
2688
ON $$||$4||$$
2689
WHERE $$||$5||$$
2690
ORDER BY left_, right_
2691
$$
2692
$_$;
2693

    
2694

    
2695
--
2696
-- Name: mk_drop_from_create(text); Type: FUNCTION; Schema: util; Owner: -
2697
--
2698

    
2699
CREATE FUNCTION mk_drop_from_create(create_cmd text) RETURNS text
2700
    LANGUAGE sql IMMUTABLE
2701
    AS $_$
2702
SELECT $$DROP $$||(util.regexp_match($1,
2703
-- match first CREATE, *if* no DROP came before it
2704
'(?m)\A(?:^(?!DROP\y).*\n)*?^CREATE(?: OR REPLACE)? ((?:)??[[:upper:]]+ .*?)(?: AS(?: (?:SELECT\y.*)?)?)?$'
2705
	/* (?:)?? makes the surrounding () group non-greedy, so that (?: AS ?)?
2706
	works properly (due to nonstandard Postgres regexp behavior:
2707
	http://www.postgresql.org/docs/9.3/static/functions-matching.html#POSIX-MATCHING-RULES) */
2708
))[1]||$$;$$
2709
$_$;
2710

    
2711

    
2712
--
2713
-- Name: mk_keys_func(regtype); Type: FUNCTION; Schema: util; Owner: -
2714
--
2715

    
2716
CREATE FUNCTION mk_keys_func(type regtype) RETURNS void
2717
    LANGUAGE sql
2718
    AS $_$
2719
-- keys()
2720
SELECT util.mk_keys_func($1, ARRAY(
2721
SELECT col FROM util.typed_cols($1) col
2722
WHERE (col).type != ANY('{bigint}'::regtype[]) -- not a count col
2723
));
2724

    
2725
-- values_()
2726
SELECT util.mk_keys_func($1, COALESCE(
2727
	NULLIF(ARRAY(
2728
	SELECT col FROM util.typed_cols($1) col
2729
	WHERE (col).type = ANY('{bigint}'::regtype[]) -- is a count col
2730
	), ARRAY[]::util.col_cast[])
2731
, ARRAY(SELECT util.typed_cols($1))) -- no count cols, so use all cols
2732
, 'values_');
2733
$_$;
2734

    
2735

    
2736
--
2737
-- Name: mk_keys_func(regtype, col_cast[], text); Type: FUNCTION; Schema: util; Owner: -
2738
--
2739

    
2740
CREATE FUNCTION mk_keys_func(type regtype, cols col_cast[], name text DEFAULT 'keys'::text) RETURNS void
2741
    LANGUAGE sql
2742
    AS $_$
2743
SELECT util.create_if_not_exists($$
2744
CREATE TYPE $$||util.prefixed_name($3||'_', $1)||$$ AS
2745
($$||util.mk_typed_cols_list($2)||$$);
2746
COMMENT ON TYPE $$||util.prefixed_name($3||'_', $1)||$$ IS '
2747
autogenerated
2748
';
2749
$$);
2750

    
2751
SELECT util.mk_keys_func($1, util.prefixed_name($3||'_', $1)::regtype, $3);
2752
$_$;
2753

    
2754

    
2755
--
2756
-- Name: mk_keys_func(regtype, regtype, text); Type: FUNCTION; Schema: util; Owner: -
2757
--
2758

    
2759
CREATE FUNCTION mk_keys_func(type regtype, return_type regtype, name text DEFAULT 'keys'::text) RETURNS void
2760
    LANGUAGE sql
2761
    AS $_$
2762
SELECT util.create_if_not_exists($$
2763
CREATE FUNCTION $$||util.qual_name(util.schema($1), $3)||$$(value $$
2764
||util.qual_name($1)||$$)
2765
  RETURNS $$||util.qual_name($2)||$$ AS
2766
$BODY1$
2767
SELECT ROW($$||
2768
(SELECT COALESCE(string_agg($$$1.$$||quote_ident((col).col_name), ', '), '')
2769
FROM util.typed_cols($2) col) ||$$)::$$||util.qual_name($2)||$$
2770
$BODY1$
2771
  LANGUAGE sql IMMUTABLE
2772
  COST 100;
2773
$$);
2774
$_$;
2775

    
2776

    
2777
--
2778
-- Name: mk_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2779
--
2780

    
2781
CREATE FUNCTION mk_map_table(table_ text) RETURNS void
2782
    LANGUAGE sql
2783
    AS $_$
2784
SELECT util.create_if_not_exists($$
2785
CREATE TABLE $$||$1||$$
2786
(
2787
    LIKE util.map INCLUDING ALL
2788
);
2789

    
2790
CREATE TRIGGER map_filter_insert
2791
  BEFORE INSERT
2792
  ON $$||$1||$$
2793
  FOR EACH ROW
2794
  EXECUTE PROCEDURE util.map_filter_insert();
2795
$$)
2796
$_$;
2797

    
2798

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

    
2803
CREATE FUNCTION mk_not_null(text) RETURNS text
2804
    LANGUAGE sql IMMUTABLE
2805
    AS $_$
2806
SELECT COALESCE($1, '<NULL>')
2807
$_$;
2808

    
2809

    
2810
--
2811
-- Name: mk_out_params(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2812
--
2813

    
2814
CREATE FUNCTION mk_out_params(cols col_cast[]) RETURNS text
2815
    LANGUAGE sql IMMUTABLE
2816
    AS $_$
2817
SELECT COALESCE(string_agg($$, OUT $$||(unnest).col_name||$$ $$||
2818
util.qual_name((unnest).type), ''), '')
2819
FROM unnest($1)
2820
$_$;
2821

    
2822

    
2823
--
2824
-- Name: mk_search_path(text[]); Type: FUNCTION; Schema: util; Owner: -
2825
--
2826

    
2827
CREATE FUNCTION mk_search_path(VARIADIC schemas text[]) RETURNS text
2828
    LANGUAGE sql IMMUTABLE
2829
    AS $_$
2830
SELECT string_agg(quote_ident(unnest), ', ') FROM unnest($1||'util'::text)
2831
$_$;
2832

    
2833

    
2834
--
2835
-- Name: FUNCTION mk_search_path(VARIADIC schemas text[]); Type: COMMENT; Schema: util; Owner: -
2836
--
2837

    
2838
COMMENT ON FUNCTION mk_search_path(VARIADIC schemas text[]) IS '
2839
auto-appends util to the search_path to enable use of util operators
2840
';
2841

    
2842

    
2843
--
2844
-- Name: mk_set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2845
--
2846

    
2847
CREATE FUNCTION mk_set_comment(table_ regclass, comment text) RETURNS text
2848
    LANGUAGE sql STABLE
2849
    AS $_$
2850
SELECT COALESCE($$COMMENT ON $$||util.relation_type($1)||$$ $$||$1||$$ IS $$
2851
||quote_literal($2)/*pass NULL through*/||$$;$$, ''/*no comment*/)
2852
$_$;
2853

    
2854

    
2855
--
2856
-- Name: mk_set_relation_metadata(regclass); Type: FUNCTION; Schema: util; Owner: -
2857
--
2858

    
2859
CREATE FUNCTION mk_set_relation_metadata(relation regclass) RETURNS text
2860
    LANGUAGE sql STABLE
2861
    AS $_$
2862
SELECT util.show_grants_for($1)
2863
||util.show_set_comment($1)||$$
2864
$$
2865
$_$;
2866

    
2867

    
2868
--
2869
-- Name: mk_set_search_path(boolean); Type: FUNCTION; Schema: util; Owner: -
2870
--
2871

    
2872
CREATE FUNCTION mk_set_search_path(for_printing boolean DEFAULT false) RETURNS text
2873
    LANGUAGE sql IMMUTABLE
2874
    AS $_$
2875
SELECT util.mk_set_search_path(current_setting('search_path'), $1)
2876
$_$;
2877

    
2878

    
2879
--
2880
-- Name: mk_set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
2881
--
2882

    
2883
CREATE FUNCTION mk_set_search_path(search_path text, for_printing boolean DEFAULT false) RETURNS text
2884
    LANGUAGE sql IMMUTABLE
2885
    AS $_$
2886
/* debug_print_return_value() needed because this function is used with EXECUTE
2887
rather than util.eval() (in order to affect the calling function), so the
2888
search_path would not otherwise be printed */
2889
SELECT $$SET$$||util._if($2, $$ /*LOCAL*/$$::text, $$ LOCAL$$)
2890
||$$ search_path TO $$||$1
2891
$_$;
2892

    
2893

    
2894
--
2895
-- Name: mk_source_col(regclass); Type: FUNCTION; Schema: util; Owner: -
2896
--
2897

    
2898
CREATE FUNCTION mk_source_col(table_ regclass) RETURNS void
2899
    LANGUAGE sql
2900
    AS $_$
2901
SELECT util.mk_const_col(($1, 'source'), util.schema($1))
2902
$_$;
2903

    
2904

    
2905
--
2906
-- Name: FUNCTION mk_source_col(table_ regclass); Type: COMMENT; Schema: util; Owner: -
2907
--
2908

    
2909
COMMENT ON FUNCTION mk_source_col(table_ regclass) IS '
2910
idempotent
2911
';
2912

    
2913

    
2914
--
2915
-- Name: mk_subset_by_row_num_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2916
--
2917

    
2918
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass) RETURNS void
2919
    LANGUAGE plpgsql STRICT
2920
    AS $_$
2921
DECLARE
2922
	view_qual_name text = util.qual_name(view_);
2923
BEGIN
2924
	EXECUTE $$
2925
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2926
  RETURNS SETOF $$||view_||$$ AS
2927
$BODY1$
2928
SELECT * FROM $$||view_qual_name||$$
2929
ORDER BY sort_col
2930
LIMIT $1 OFFSET $2
2931
$BODY1$
2932
  LANGUAGE sql STABLE
2933
  COST 100
2934
  ROWS 1000
2935
$$;
2936
	
2937
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2938
END;
2939
$_$;
2940

    
2941

    
2942
--
2943
-- Name: mk_subset_by_row_num_func(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2944
--
2945

    
2946
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass, row_num_col text) RETURNS void
2947
    LANGUAGE plpgsql STRICT
2948
    AS $_$
2949
DECLARE
2950
	view_qual_name text = util.qual_name(view_);
2951
	row_num__min__fn text = util.esc_name__append('__row_num__min', view_qual_name);
2952
BEGIN
2953
	EXECUTE $$
2954
CREATE OR REPLACE FUNCTION $$||row_num__min__fn||$$()
2955
  RETURNS integer AS
2956
$BODY1$
2957
SELECT $$||quote_ident(row_num_col)||$$
2958
FROM $$||view_qual_name||$$
2959
ORDER BY $$||quote_ident(row_num_col)||$$ ASC
2960
LIMIT 1
2961
$BODY1$
2962
  LANGUAGE sql STABLE
2963
  COST 100;
2964
$$;
2965
	
2966
	EXECUTE $$
2967
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2968
  RETURNS SETOF $$||view_||$$ AS
2969
$BODY1$
2970
SELECT * FROM $$||view_qual_name||$$
2971
WHERE $$||quote_ident(row_num_col)||$$ BETWEEN
2972
	util.offset2row_num(    $2, $$||row_num__min__fn||$$())
2973
AND util.limit2row_num ($1, $2, $$||row_num__min__fn||$$())
2974
ORDER BY $$||quote_ident(row_num_col)||$$
2975
$BODY1$
2976
  LANGUAGE sql STABLE
2977
  COST 100
2978
  ROWS 1000
2979
$$;
2980
	
2981
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2982
END;
2983
$_$;
2984

    
2985

    
2986
--
2987
-- Name: mk_subset_by_row_num_no_sort_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2988
--
2989

    
2990
CREATE FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) RETURNS void
2991
    LANGUAGE plpgsql STRICT
2992
    AS $_$
2993
DECLARE
2994
	view_qual_name text = util.qual_name(view_);
2995
BEGIN
2996
	EXECUTE $$
2997
CREATE OR REPLACE FUNCTION $$||view_||$$(no_sort boolean, limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2998
  RETURNS SETOF $$||view_||$$
2999
  SET enable_sort TO 'off'
3000
  AS
3001
$BODY1$
3002
SELECT * FROM $$||view_qual_name||$$($2, $3)
3003
$BODY1$
3004
  LANGUAGE sql STABLE
3005
  COST 100
3006
  ROWS 1000
3007
;
3008
COMMENT ON FUNCTION $$||view_||$$(no_sort boolean, limit_ integer, offset_ integer) IS '
3009
Use this for limit values greater than ~100,000 to avoid unwanted slow sorts.
3010
If you want to run EXPLAIN and get expanded output, use the regular subset
3011
function instead. (When a config param is set on a function, EXPLAIN produces
3012
just a function scan.)
3013
';
3014
$$;
3015
END;
3016
$_$;
3017

    
3018

    
3019
--
3020
-- Name: FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass); Type: COMMENT; Schema: util; Owner: -
3021
--
3022

    
3023
COMMENT ON FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) IS '
3024
creates subset function which turns off enable_sort
3025
';
3026

    
3027

    
3028
--
3029
-- Name: mk_typed_cols_list(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
3030
--
3031

    
3032
CREATE FUNCTION mk_typed_cols_list(cols col_cast[]) RETURNS text
3033
    LANGUAGE sql IMMUTABLE
3034
    AS $_$
3035
SELECT COALESCE(string_agg(quote_ident((unnest).col_name)||$$ $$||
3036
util.qual_name((unnest).type), ', '), '')
3037
FROM unnest($1)
3038
$_$;
3039

    
3040

    
3041
--
3042
-- Name: name(regclass); Type: FUNCTION; Schema: util; Owner: -
3043
--
3044

    
3045
CREATE FUNCTION name(table_ regclass) RETURNS text
3046
    LANGUAGE sql STABLE
3047
    AS $_$
3048
SELECT relname::text FROM pg_class WHERE oid = $1
3049
$_$;
3050

    
3051

    
3052
--
3053
-- Name: name(regtype); Type: FUNCTION; Schema: util; Owner: -
3054
--
3055

    
3056
CREATE FUNCTION name(type regtype) RETURNS text
3057
    LANGUAGE sql STABLE
3058
    AS $_$
3059
SELECT typname::text FROM pg_type WHERE oid = $1
3060
$_$;
3061

    
3062

    
3063
--
3064
-- Name: name_was_truncated(text, integer); Type: FUNCTION; Schema: util; Owner: -
3065
--
3066

    
3067
CREATE FUNCTION name_was_truncated(name_ text, max_prefix_len integer DEFAULT 0) RETURNS boolean
3068
    LANGUAGE sql IMMUTABLE
3069
    AS $_$
3070
SELECT octet_length($1) >= util.namedatalen() - $2
3071
$_$;
3072

    
3073

    
3074
--
3075
-- Name: namedatalen(); Type: FUNCTION; Schema: util; Owner: -
3076
--
3077

    
3078
CREATE FUNCTION namedatalen() RETURNS integer
3079
    LANGUAGE sql IMMUTABLE
3080
    AS $$
3081
SELECT octet_length(repeat('_', 1024/*>63*/)::name::text)
3082
$$;
3083

    
3084

    
3085
--
3086
-- Name: new_world(); Type: FUNCTION; Schema: util; Owner: -
3087
--
3088

    
3089
CREATE FUNCTION new_world() RETURNS postgis.geography
3090
    LANGUAGE sql IMMUTABLE
3091
    SET search_path TO util
3092
    AS $$
3093
SELECT util.bounding_box(-56 ~ 83, 172 ~ -34)
3094
$$;
3095

    
3096

    
3097
--
3098
-- Name: not_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
3099
--
3100

    
3101
CREATE FUNCTION not_empty(value anyarray) RETURNS boolean
3102
    LANGUAGE sql IMMUTABLE
3103
    AS $_$
3104
SELECT $1 IS NOT NULL AND util.array_length($1) > 0
3105
$_$;
3106

    
3107

    
3108
--
3109
-- Name: not_null(anyelement); Type: FUNCTION; Schema: util; Owner: -
3110
--
3111

    
3112
CREATE FUNCTION not_null(value anyelement) RETURNS boolean
3113
    LANGUAGE sql IMMUTABLE
3114
    AS $_$
3115
SELECT $1 IS NOT NULL
3116
$_$;
3117

    
3118

    
3119
--
3120
-- Name: nulls_map(text[]); Type: FUNCTION; Schema: util; Owner: -
3121
--
3122

    
3123
CREATE FUNCTION nulls_map(nulls text[]) RETURNS hstore
3124
    LANGUAGE sql IMMUTABLE
3125
    AS $_$
3126
SELECT util.hstore($1, NULL) || '*=>*'
3127
$_$;
3128

    
3129

    
3130
--
3131
-- Name: FUNCTION nulls_map(nulls text[]); Type: COMMENT; Schema: util; Owner: -
3132
--
3133

    
3134
COMMENT ON FUNCTION nulls_map(nulls text[]) IS '
3135
for use with _map()
3136
';
3137

    
3138

    
3139
--
3140
-- Name: numrange(range); Type: FUNCTION; Schema: util; Owner: -
3141
--
3142

    
3143
CREATE FUNCTION numrange(value range) RETURNS numrange
3144
    LANGUAGE sql IMMUTABLE
3145
    AS $_$
3146
SELECT numrange($1.lower, $1.upper, $1.bounds)
3147
$_$;
3148

    
3149

    
3150
--
3151
-- Name: offset2row_num(integer, integer); Type: FUNCTION; Schema: util; Owner: -
3152
--
3153

    
3154
CREATE FUNCTION offset2row_num(offset_ integer, min_row_num integer DEFAULT 1) RETURNS integer
3155
    LANGUAGE sql IMMUTABLE
3156
    AS $_$
3157
SELECT $2 + COALESCE($1, 0)
3158
$_$;
3159

    
3160

    
3161
--
3162
-- Name: parent(regclass); Type: FUNCTION; Schema: util; Owner: -
3163
--
3164

    
3165
CREATE FUNCTION parent(table_ regclass) RETURNS regclass
3166
    LANGUAGE sql STABLE
3167
    AS $_$
3168
SELECT inhparent FROM pg_inherits WHERE inhrelid = $1
3169
$_$;
3170

    
3171

    
3172
--
3173
-- Name: pg_get_viewdef(regclass); Type: FUNCTION; Schema: util; Owner: -
3174
--
3175

    
3176
CREATE FUNCTION pg_get_viewdef(view_ regclass) RETURNS text
3177
    LANGUAGE sql STABLE
3178
    AS $_$
3179
SELECT util.view_def_to_orig(pg_catalog.pg_get_viewdef($1))
3180
$_$;
3181

    
3182

    
3183
--
3184
-- Name: populate_table(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3185
--
3186

    
3187
CREATE FUNCTION populate_table(table_ regclass, sql text) RETURNS void
3188
    LANGUAGE sql
3189
    AS $_$
3190
SELECT util.eval($$INSERT INTO $$||$1||$$
3191
$$||util.ltrim_nl($2));
3192
-- make sure the created table has the correct estimated row count
3193
SELECT util.analyze_($1);
3194
$_$;
3195

    
3196

    
3197
--
3198
-- Name: prefixed_name(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
3199
--
3200

    
3201
CREATE FUNCTION prefixed_name(prefix text, type anyelement) RETURNS text
3202
    LANGUAGE sql IMMUTABLE
3203
    AS $_$
3204
SELECT util.qual_name(util.schema($2), $1||util.name($2))
3205
$_$;
3206

    
3207

    
3208
--
3209
-- Name: prepend_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3210
--
3211

    
3212
CREATE FUNCTION prepend_comment(table_ regclass, comment text) RETURNS void
3213
    LANGUAGE sql
3214
    AS $_$
3215
SELECT util.set_comment($1, concat($2, util.comment($1)))
3216
$_$;
3217

    
3218

    
3219
--
3220
-- Name: FUNCTION prepend_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
3221
--
3222

    
3223
COMMENT ON FUNCTION prepend_comment(table_ regclass, comment text) IS '
3224
comment: must start and end with a newline
3225
';
3226

    
3227

    
3228
--
3229
-- Name: qual_name(text[]); Type: FUNCTION; Schema: util; Owner: -
3230
--
3231

    
3232
CREATE FUNCTION qual_name(VARIADIC elems text[]) RETURNS text
3233
    LANGUAGE sql IMMUTABLE
3234
    AS $_$
3235
SELECT string_agg(quote_ident(unnest), '.') FROM unnest($1)
3236
$_$;
3237

    
3238

    
3239
--
3240
-- Name: qual_name(regclass); Type: FUNCTION; Schema: util; Owner: -
3241
--
3242

    
3243
CREATE FUNCTION qual_name(table_ regclass) RETURNS text
3244
    LANGUAGE sql STABLE
3245
    SET search_path TO pg_temp
3246
    AS $_$
3247
SELECT $1::text
3248
$_$;
3249

    
3250

    
3251
--
3252
-- Name: qual_name(regtype); Type: FUNCTION; Schema: util; Owner: -
3253
--
3254

    
3255
CREATE FUNCTION qual_name(type regtype) RETURNS text
3256
    LANGUAGE sql STABLE
3257
    SET search_path TO pg_temp
3258
    AS $_$
3259
SELECT $1::text
3260
$_$;
3261

    
3262

    
3263
--
3264
-- Name: FUNCTION qual_name(type regtype); Type: COMMENT; Schema: util; Owner: -
3265
--
3266

    
3267
COMMENT ON FUNCTION qual_name(type regtype) IS '
3268
a type''s schema-qualified name
3269
';
3270

    
3271

    
3272
--
3273
-- Name: qual_name(unknown); Type: FUNCTION; Schema: util; Owner: -
3274
--
3275

    
3276
CREATE FUNCTION qual_name(type unknown) RETURNS text
3277
    LANGUAGE sql STABLE
3278
    AS $_$
3279
SELECT util.qual_name($1::text::regtype)
3280
$_$;
3281

    
3282

    
3283
--
3284
-- Name: quote_func_call(regprocedure, text[]); Type: FUNCTION; Schema: util; Owner: -
3285
--
3286

    
3287
CREATE FUNCTION quote_func_call(func regprocedure, VARIADIC args_esc text[]) RETURNS text
3288
    LANGUAGE sql IMMUTABLE
3289
    AS $_$
3290
SELECT util.quote_func_call($1::regproc::text, VARIADIC $2)
3291
$_$;
3292

    
3293

    
3294
--
3295
-- Name: quote_func_call(text, text[]); Type: FUNCTION; Schema: util; Owner: -
3296
--
3297

    
3298
CREATE FUNCTION quote_func_call(func_esc text, VARIADIC args_esc text[]) RETURNS text
3299
    LANGUAGE sql IMMUTABLE
3300
    AS $_$
3301
SELECT $1||'('||concat_ws(', ', VARIADIC $2)||')'
3302
$_$;
3303

    
3304

    
3305
--
3306
-- Name: quote_typed(anyelement); Type: FUNCTION; Schema: util; Owner: -
3307
--
3308

    
3309
CREATE FUNCTION quote_typed(value anyelement) RETURNS text
3310
    LANGUAGE sql IMMUTABLE
3311
    AS $_$
3312
SELECT quote_nullable($1)||$$::$$||util.qual_name(pg_typeof($1))
3313
$_$;
3314

    
3315

    
3316
--
3317
-- Name: raise(text, text); Type: FUNCTION; Schema: util; Owner: -
3318
--
3319

    
3320
CREATE FUNCTION raise(type text, msg text) RETURNS void
3321
    LANGUAGE sql IMMUTABLE
3322
    AS $_X$
3323
SELECT util.eval($$
3324
CREATE OR REPLACE FUNCTION pg_temp.__raise()
3325
  RETURNS void AS
3326
-- $__BODY1$ in case msg contains $BODY1$ (in SQL)
3327
$__BODY1$
3328
BEGIN
3329
	RAISE $$||$1||$$ USING MESSAGE = $$||quote_nullable($2)||$$;
3330
END;
3331
$__BODY1$
3332
  LANGUAGE plpgsql IMMUTABLE
3333
  COST 100;
3334
$$, verbose_ := false);
3335

    
3336
SELECT util.eval($$SELECT pg_temp.__raise()$$, verbose_ := false);
3337
$_X$;
3338

    
3339

    
3340
--
3341
-- Name: FUNCTION raise(type text, msg text); Type: COMMENT; Schema: util; Owner: -
3342
--
3343

    
3344
COMMENT ON FUNCTION raise(type text, msg text) IS '
3345
type: a log level from
3346
http://www.postgresql.org/docs/9.3/static/plpgsql-errors-and-messages.html
3347
or a condition name from
3348
http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
3349
';
3350

    
3351

    
3352
--
3353
-- Name: raise_error_warning(text); Type: FUNCTION; Schema: util; Owner: -
3354
--
3355

    
3356
CREATE FUNCTION raise_error_warning(msg text) RETURNS void
3357
    LANGUAGE sql IMMUTABLE
3358
    AS $_$
3359
SELECT util.raise('WARNING', 'ERROR:  '||$1)
3360
$_$;
3361

    
3362

    
3363
--
3364
-- Name: raise_undefined_column(col_ref); Type: FUNCTION; Schema: util; Owner: -
3365
--
3366

    
3367
CREATE FUNCTION raise_undefined_column(col col_ref) RETURNS text
3368
    LANGUAGE plpgsql IMMUTABLE STRICT
3369
    AS $$
3370
BEGIN
3371
	RAISE undefined_column USING MESSAGE = concat('undefined column: ', col.name);
3372
END;
3373
$$;
3374

    
3375

    
3376
--
3377
-- Name: range(numeric, numeric); Type: FUNCTION; Schema: util; Owner: -
3378
--
3379

    
3380
CREATE FUNCTION range(lower numeric, upper numeric) RETURNS range
3381
    LANGUAGE sql IMMUTABLE
3382
    AS $_$
3383
SELECT ($1, $2, '[]')::util.range
3384
$_$;
3385

    
3386

    
3387
--
3388
-- Name: recreate(text, text[]); Type: FUNCTION; Schema: util; Owner: -
3389
--
3390

    
3391
CREATE FUNCTION recreate(cmd text, users text[] DEFAULT NULL::text[]) RETURNS void
3392
    LANGUAGE plpgsql
3393
    AS $_$
3394
DECLARE
3395
	PG_EXCEPTION_DETAIL text;
3396
	restore_views_info util.restore_views_info;
3397
BEGIN
3398
	restore_views_info = util.save_drop_views(users);
3399
	
3400
	-- trigger the dependent_objects_still_exist exception
3401
	PERFORM util.eval(COALESCE(util.mk_drop_from_create(cmd), '')||cmd);
3402
		-- *not* CASCADE; it must trigger an exception
3403
	
3404
	PERFORM util.restore_views(restore_views_info);
3405
EXCEPTION
3406
WHEN dependent_objects_still_exist THEN
3407
	IF users IS NOT NULL THEN RAISE; END IF; -- save_drop_views() didn't fix it
3408
	GET STACKED DIAGNOSTICS PG_EXCEPTION_DETAIL = PG_EXCEPTION_DETAIL;
3409
	users = array(SELECT * FROM util.regexp_matches_group(
3410
		PG_EXCEPTION_DETAIL, '(?m)^view (.*) depends on [[:lower:]]+ .*$'));
3411
		-- will be in forward dependency order
3412
	PERFORM util.debug_print_var('PG_EXCEPTION_DETAIL', PG_EXCEPTION_DETAIL);
3413
	PERFORM util.debug_print_var('users', users);
3414
	IF util.is_empty(users) THEN RAISE; END IF;
3415
	PERFORM util.recreate(cmd, users);
3416
END;
3417
$_$;
3418

    
3419

    
3420
--
3421
-- Name: FUNCTION recreate(cmd text, users text[]); Type: COMMENT; Schema: util; Owner: -
3422
--
3423

    
3424
COMMENT ON FUNCTION recreate(cmd text, users text[]) IS '
3425
the appropriate drop statement will be added automatically.
3426

    
3427
usage:
3428
SELECT util.recreate($$
3429
CREATE VIEW schema.main_view AS _;
3430

    
3431
-- manually restore views that need to be updated for the changes
3432
CREATE VIEW schema.dependent_view AS _;
3433
$$);
3434

    
3435
idempotent
3436

    
3437
users: not necessary to provide this because it will be autopopulated
3438
';
3439

    
3440

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

    
3445
CREATE FUNCTION recreate_view(view_ regclass, view_query text DEFAULT NULL::text, dependent_view_changes text DEFAULT ''::text) RETURNS void
3446
    LANGUAGE sql
3447
    AS $_$
3448
SELECT util.recreate($$
3449
CREATE VIEW $$||$1||$$ AS 
3450
$$||COALESCE($2, pg_get_viewdef($1))||$$;
3451
$$||util.mk_set_relation_metadata($1)||$$
3452

    
3453
-- manually restore views that need to be updated for the changes
3454
$$||$3||$$
3455
$$);
3456
$_$;
3457

    
3458

    
3459
--
3460
-- Name: FUNCTION recreate_view(view_ regclass, view_query text, dependent_view_changes text); Type: COMMENT; Schema: util; Owner: -
3461
--
3462

    
3463
COMMENT ON FUNCTION recreate_view(view_ regclass, view_query text, dependent_view_changes text) IS '
3464
usage:
3465
SELECT util.recreate_view(''schema.main_view'', $$
3466
SELECT __
3467
$$, $$
3468
CREATE VIEW schema.dependent_view AS 
3469
__;
3470
$$||util.mk_set_relation_metadata(''schema.dependent_view'')||$$
3471
$$);
3472

    
3473
if view has already been modified:
3474
SELECT util.recreate_view(''schema.main_view'', dependent_view_changes := $$
3475
CREATE VIEW schema.dependent_view AS 
3476
__;
3477
$$||util.mk_set_relation_metadata(''schema.dependent_view'')||$$
3478
$$);
3479

    
3480
idempotent
3481
';
3482

    
3483

    
3484
--
3485
-- Name: regexp_match(text, text); Type: FUNCTION; Schema: util; Owner: -
3486
--
3487

    
3488
CREATE FUNCTION regexp_match(str text, re text) RETURNS text[]
3489
    LANGUAGE sql IMMUTABLE
3490
    AS $_$
3491
SELECT match FROM regexp_matches($1, $2) match LIMIT 1/*only 1st match*/
3492
$_$;
3493

    
3494

    
3495
--
3496
-- Name: regexp_matches_group(text, text, integer); Type: FUNCTION; Schema: util; Owner: -
3497
--
3498

    
3499
CREATE FUNCTION regexp_matches_group(str text, re text, group_ integer DEFAULT 1) RETURNS SETOF text
3500
    LANGUAGE sql IMMUTABLE
3501
    AS $_$
3502
SELECT regexp_matches[$3] FROM regexp_matches($1, $2, 'g')
3503
$_$;
3504

    
3505

    
3506
--
3507
-- Name: regexp_quote(text); Type: FUNCTION; Schema: util; Owner: -
3508
--
3509

    
3510
CREATE FUNCTION regexp_quote(str text) RETURNS text
3511
    LANGUAGE sql IMMUTABLE
3512
    AS $_$
3513
SELECT regexp_replace($1, '\W', /*\char*/'\\\&', 'g')
3514
$_$;
3515

    
3516

    
3517
--
3518
-- Name: regprocedure(text); Type: FUNCTION; Schema: util; Owner: -
3519
--
3520

    
3521
CREATE FUNCTION regprocedure(func text) RETURNS regprocedure
3522
    LANGUAGE sql IMMUTABLE
3523
    AS $_$
3524
SELECT (CASE WHEN right($1, 1) = ')'
3525
THEN $1::regprocedure ELSE $1::regproc::regprocedure END)
3526
$_$;
3527

    
3528

    
3529
--
3530
-- Name: relation_exists(text); Type: FUNCTION; Schema: util; Owner: -
3531
--
3532

    
3533
CREATE FUNCTION relation_exists(relation text) RETURNS boolean
3534
    LANGUAGE sql STABLE
3535
    AS $_$
3536
SELECT $1 IS NOT NULL AND util.is_castable($1, NULL::regclass)
3537
$_$;
3538

    
3539

    
3540
--
3541
-- Name: relation_type(regclass); Type: FUNCTION; Schema: util; Owner: -
3542
--
3543

    
3544
CREATE FUNCTION relation_type(relation regclass) RETURNS text
3545
    LANGUAGE sql STABLE
3546
    AS $_$
3547
SELECT util.relation_type(util.relation_type_char($1))
3548
$_$;
3549

    
3550

    
3551
--
3552
-- Name: relation_type("char"); Type: FUNCTION; Schema: util; Owner: -
3553
--
3554

    
3555
CREATE FUNCTION relation_type(relation_type_char "char") RETURNS text
3556
    LANGUAGE sql IMMUTABLE
3557
    AS $_$
3558
SELECT 'c=>TYPE, r=>TABLE, v=>VIEW'::hstore -> $1
3559
$_$;
3560

    
3561

    
3562
--
3563
-- Name: relation_type(regtype); Type: FUNCTION; Schema: util; Owner: -
3564
--
3565

    
3566
CREATE FUNCTION relation_type(type regtype) RETURNS text
3567
    LANGUAGE sql IMMUTABLE
3568
    AS $$
3569
SELECT 'TYPE'::text
3570
$$;
3571

    
3572

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

    
3577
CREATE FUNCTION relation_type_char(relation regclass) RETURNS "char"
3578
    LANGUAGE sql STABLE
3579
    AS $_$
3580
SELECT relkind FROM pg_class WHERE oid = $1
3581
$_$;
3582

    
3583

    
3584
--
3585
-- Name: remake_diff_table(text, regclass, regclass, text); Type: FUNCTION; Schema: util; Owner: -
3586
--
3587

    
3588
CREATE FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) RETURNS void
3589
    LANGUAGE sql
3590
    AS $_$
3591
/* can't have in_table/out_table inherit from *each other*, because inheritance
3592
also causes the rows of the parent table to be included in the child table.
3593
instead, they need to inherit from a common, empty table. */
3594
SELECT util.create_if_not_exists($$SELECT $$||util.quote_func_call(
3595
'util.copy_struct', util.quote_typed($2), util.quote_typed($4)));
3596
SELECT util.rm_freq(ARRAY[$4]); -- left/right_table don't have freq yet
3597
SELECT util.inherit($2, $4);
3598
SELECT util.inherit($3, $4);
3599

    
3600
SELECT util.rematerialize_query($1, $$
3601
SELECT * FROM util.diff(
3602
  $$||util.quote_typed($2)||$$
3603
, $$||util.quote_typed($3)||$$
3604
, NULL::$$||$4||$$)
3605
$$);
3606

    
3607
/* the table unfortunately cannot be *materialized* in human-readable form,
3608
because this would create column name collisions between the two sides */
3609
SELECT util.prepend_comment($1, '
3610
to view this table in human-readable form (with each side''s tuple column
3611
expanded to its component fields):
3612
SELECT (left_).*, ('||util.schema($4::regclass)||'.values_(right_)).* FROM '||$1||';
3613

    
3614
to display NULL values that are extra or missing:
3615
SELECT * FROM '||$1||';
3616
');
3617
$_$;
3618

    
3619

    
3620
--
3621
-- Name: FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text); Type: COMMENT; Schema: util; Owner: -
3622
--
3623

    
3624
COMMENT ON FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) IS '
3625
type_table (*required*): table to create as the shared base type
3626
';
3627

    
3628

    
3629
--
3630
-- Name: rematerialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
3631
--
3632

    
3633
CREATE FUNCTION rematerialize_query(table_esc text, sql text) RETURNS void
3634
    LANGUAGE sql
3635
    AS $_$
3636
SELECT util.drop_table($1);
3637
SELECT util.materialize_query($1, $2);
3638
$_$;
3639

    
3640

    
3641
--
3642
-- Name: FUNCTION rematerialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
3643
--
3644

    
3645
COMMENT ON FUNCTION rematerialize_query(table_esc text, sql text) IS '
3646
idempotent, but repeats action each time
3647
';
3648

    
3649

    
3650
--
3651
-- Name: rematerialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
3652
--
3653

    
3654
CREATE FUNCTION rematerialize_view(table_esc text, view_ regclass) RETURNS void
3655
    LANGUAGE sql
3656
    AS $_$
3657
SELECT util.drop_table($1);
3658
SELECT util.materialize_view($1, $2);
3659
$_$;
3660

    
3661

    
3662
--
3663
-- Name: FUNCTION rematerialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
3664
--
3665

    
3666
COMMENT ON FUNCTION rematerialize_view(table_esc text, view_ regclass) IS '
3667
idempotent, but repeats action each time
3668
';
3669

    
3670

    
3671
--
3672
-- Name: rename_cols(regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
3673
--
3674

    
3675
CREATE FUNCTION rename_cols(table_ regclass, renames anyelement) RETURNS void
3676
    LANGUAGE sql
3677
    AS $_$
3678
SELECT util.try_create($$ALTER TABLE $$||$1||$$ RENAME $$
3679
||quote_ident(name)||$$ TO $$||quote_ident($2 -> name))
3680
FROM util.col_names($1::text::regtype) f (name);
3681
SELECT NULL::void; -- don't fold away functions called in previous query
3682
$_$;
3683

    
3684

    
3685
--
3686
-- Name: FUNCTION rename_cols(table_ regclass, renames anyelement); Type: COMMENT; Schema: util; Owner: -
3687
--
3688

    
3689
COMMENT ON FUNCTION rename_cols(table_ regclass, renames anyelement) IS '
3690
idempotent
3691
';
3692

    
3693

    
3694
--
3695
-- Name: rename_relation(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3696
--
3697

    
3698
CREATE FUNCTION rename_relation(from_ regclass, to_ text) RETURNS void
3699
    LANGUAGE sql
3700
    AS $_$
3701
/* use util.qual_name() instead of ::text so that the schema qualifier is always
3702
included in the debug SQL */
3703
SELECT util.rename_relation(util.qual_name($1), $2)
3704
$_$;
3705

    
3706

    
3707
--
3708
-- Name: rename_relation(text, text); Type: FUNCTION; Schema: util; Owner: -
3709
--
3710

    
3711
CREATE FUNCTION rename_relation(from_esc text, to_name text) RETURNS void
3712
    LANGUAGE sql
3713
    AS $_$
3714
/* 'ALTER TABLE can be used with views too'
3715
(http://www.postgresql.org/docs/9.3/static/sql-alterview.html) */
3716
SELECT util.eval($$ALTER TABLE IF EXISTS $$||$1||$$ RENAME TO $$
3717
||quote_ident($2))
3718
$_$;
3719

    
3720

    
3721
--
3722
-- Name: FUNCTION rename_relation(from_esc text, to_name text); Type: COMMENT; Schema: util; Owner: -
3723
--
3724

    
3725
COMMENT ON FUNCTION rename_relation(from_esc text, to_name text) IS '
3726
idempotent
3727
';
3728

    
3729

    
3730
--
3731
-- Name: replace_suffix(text, text, text, integer); Type: FUNCTION; Schema: util; Owner: -
3732
--
3733

    
3734
CREATE FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer DEFAULT 0) RETURNS text
3735
    LANGUAGE sql IMMUTABLE
3736
    AS $_$
3737
SELECT regexp_replace($1, util.truncated_prefixed_name_regexp($2, $4), '\1'||$3)
3738
$_$;
3739

    
3740

    
3741
--
3742
-- Name: FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer); Type: COMMENT; Schema: util; Owner: -
3743
--
3744

    
3745
COMMENT ON FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer) IS '
3746
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 
3747
';
3748

    
3749

    
3750
--
3751
-- Name: reset_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3752
--
3753

    
3754
CREATE FUNCTION reset_col_names(table_ regclass, names regclass) RETURNS void
3755
    LANGUAGE sql
3756
    AS $_$
3757
SELECT util.eval($$DELETE FROM $$||$2||$$ WHERE "from" LIKE ':%'$$);
3758
SELECT util.mk_derived_col(($2, 'to'), $$"from"$$, overwrite := true);
3759
SELECT util.set_col_names($1, $2);
3760
$_$;
3761

    
3762

    
3763
--
3764
-- Name: FUNCTION reset_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3765
--
3766

    
3767
COMMENT ON FUNCTION reset_col_names(table_ regclass, names regclass) IS '
3768
idempotent.
3769
alters the names table, so it will need to be repopulated after running this function.
3770
';
3771

    
3772

    
3773
--
3774
-- Name: reset_map_table(text); Type: FUNCTION; Schema: util; Owner: -
3775
--
3776

    
3777
CREATE FUNCTION reset_map_table(table_ text) RETURNS void
3778
    LANGUAGE sql
3779
    AS $_$
3780
SELECT util.drop_table($1);
3781
SELECT util.mk_map_table($1);
3782
$_$;
3783

    
3784

    
3785
--
3786
-- Name: restore_views(restore_views_info); Type: FUNCTION; Schema: util; Owner: -
3787
--
3788

    
3789
CREATE FUNCTION restore_views(restore_views_info) RETURNS void
3790
    LANGUAGE sql
3791
    AS $_$
3792
SELECT util.debug_print_var('views', $1);
3793
SELECT util.create_if_not_exists((view_).def, (view_).path)
3794
	/* need to specify view name for manual existence check, in case view def
3795
	becomes invalid, which would produce nonstandard (uncatchable) exception */
3796
FROM unnest($1.views) view_; -- in forward dependency order
3797
	/* create_if_not_exists() rather than eval(), because cmd might manually
3798
	re-create a deleted dependent view, causing it to already exist */
3799
SELECT NULL::void; -- don't fold away functions called in previous query
3800
$_$;
3801

    
3802

    
3803
--
3804
-- Name: rm_freq(regclass[], text); Type: FUNCTION; Schema: util; Owner: -
3805
--
3806

    
3807
CREATE FUNCTION rm_freq(tables regclass[], freq_col text DEFAULT 'copies'::text) RETURNS void
3808
    LANGUAGE sql
3809
    AS $_$
3810
SELECT util.drop_column($1, $2, force := true)
3811
$_$;
3812

    
3813

    
3814
--
3815
-- Name: rtrim_n(text, integer); Type: FUNCTION; Schema: util; Owner: -
3816
--
3817

    
3818
CREATE FUNCTION rtrim_n(str text, count integer) RETURNS text
3819
    LANGUAGE sql IMMUTABLE
3820
    AS $_$
3821
SELECT (CASE WHEN $2 <= 0 THEN $1 ELSE left($1, -$2) END)
3822
$_$;
3823

    
3824

    
3825
--
3826
-- Name: runnable_sql(text); Type: FUNCTION; Schema: util; Owner: -
3827
--
3828

    
3829
CREATE FUNCTION runnable_sql(sql text) RETURNS text
3830
    LANGUAGE sql IMMUTABLE
3831
    AS $_$
3832
SELECT (CASE WHEN util.is_set_stmt($1) THEN ''
3833
ELSE util.mk_set_search_path(for_printing := true)||$$;
3834
$$ END)||$1
3835
$_$;
3836

    
3837

    
3838
--
3839
-- Name: save_drop_view(text); Type: FUNCTION; Schema: util; Owner: -
3840
--
3841

    
3842
CREATE FUNCTION save_drop_view(view_ text) RETURNS text
3843
    LANGUAGE plpgsql STRICT
3844
    AS $$
3845
DECLARE
3846
	result text = NULL;
3847
BEGIN
3848
	BEGIN
3849
		result = util.show_create_view(view_, replace := false);
3850
			/* replace: no `OR REPLACE` because that causes nonuniform errors
3851
			(eg. invalid_table_definition), instead of the standard
3852
			duplicate_table exception caught by util.create_if_not_exists() */
3853
		PERFORM util.drop_view(view_);
3854
	EXCEPTION
3855
		WHEN undefined_table THEN NULL;
3856
	END;
3857
	RETURN result;
3858
END;
3859
$$;
3860

    
3861

    
3862
--
3863
-- Name: save_drop_views(text[]); Type: FUNCTION; Schema: util; Owner: -
3864
--
3865

    
3866
CREATE FUNCTION save_drop_views(views text[]) RETURNS restore_views_info
3867
    LANGUAGE sql
3868
    AS $_$
3869
SELECT ROW(/*return in forward dependency order*/util.array_reverse(array(
3870
SELECT (view_, util.save_drop_view(view_))::util.db_item
3871
FROM unnest(/*drop in reverse dependency order*/util.array_reverse($1)) view_
3872
)))::util.restore_views_info
3873
$_$;
3874

    
3875

    
3876
--
3877
-- Name: schema(oid); Type: FUNCTION; Schema: util; Owner: -
3878
--
3879

    
3880
CREATE FUNCTION schema(pg_namespace_oid oid) RETURNS text
3881
    LANGUAGE sql STABLE
3882
    AS $_$
3883
SELECT nspname::text FROM pg_namespace WHERE pg_namespace.oid = $1
3884
$_$;
3885

    
3886

    
3887
--
3888
-- Name: schema(regclass); Type: FUNCTION; Schema: util; Owner: -
3889
--
3890

    
3891
CREATE FUNCTION schema(table_ regclass) RETURNS text
3892
    LANGUAGE sql STABLE
3893
    AS $_$
3894
SELECT util.schema(relnamespace) FROM pg_class WHERE oid = $1
3895
$_$;
3896

    
3897

    
3898
--
3899
-- Name: schema(regtype); Type: FUNCTION; Schema: util; Owner: -
3900
--
3901

    
3902
CREATE FUNCTION schema(type regtype) RETURNS text
3903
    LANGUAGE sql STABLE
3904
    AS $_$
3905
SELECT util.schema(typnamespace) FROM pg_type WHERE oid = $1
3906
$_$;
3907

    
3908

    
3909
--
3910
-- Name: schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3911
--
3912

    
3913
CREATE FUNCTION schema(type_null anyelement) RETURNS text
3914
    LANGUAGE sql STABLE
3915
    AS $_$
3916
SELECT util.schema(pg_typeof($1))
3917
$_$;
3918

    
3919

    
3920
--
3921
-- Name: schema_bundle_get_schemas(text); Type: FUNCTION; Schema: util; Owner: -
3922
--
3923

    
3924
CREATE FUNCTION schema_bundle_get_schemas(schema_bundle text) RETURNS SETOF text
3925
    LANGUAGE sql STABLE
3926
    AS $_$
3927
SELECT nspname::text FROM pg_namespace WHERE nspname ~ ('^'||$1||'(?=\y|_)')
3928
$_$;
3929

    
3930

    
3931
--
3932
-- Name: FUNCTION schema_bundle_get_schemas(schema_bundle text); Type: COMMENT; Schema: util; Owner: -
3933
--
3934

    
3935
COMMENT ON FUNCTION schema_bundle_get_schemas(schema_bundle text) IS '
3936
a schema bundle is a group of schemas with a common prefix
3937
';
3938

    
3939

    
3940
--
3941
-- Name: schema_bundle_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3942
--
3943

    
3944
CREATE FUNCTION schema_bundle_rename(old text, new text) RETURNS void
3945
    LANGUAGE sql
3946
    AS $_$
3947
SELECT util.schema_rename(old_schema,
3948
	overlay(old_schema placing new from 1 for length(old))) -- replace prefix
3949
FROM util.schema_bundle_get_schemas($1) f (old_schema);
3950
SELECT NULL::void; -- don't fold away functions called in previous query
3951
$_$;
3952

    
3953

    
3954
--
3955
-- Name: schema_bundle_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3956
--
3957

    
3958
CREATE FUNCTION schema_bundle_replace(replace text, with_ text) RETURNS void
3959
    LANGUAGE plpgsql
3960
    AS $$
3961
BEGIN
3962
	-- don't schema_bundle_rm() the schema_bundle to keep!
3963
	IF replace = with_ THEN RETURN; END IF;
3964
	
3965
	PERFORM util.schema_bundle_rm(replace);
3966
	PERFORM util.schema_bundle_rename(with_, replace);
3967
END;
3968
$$;
3969

    
3970

    
3971
--
3972
-- Name: schema_bundle_rm(text); Type: FUNCTION; Schema: util; Owner: -
3973
--
3974

    
3975
CREATE FUNCTION schema_bundle_rm(schema_bundle text) RETURNS void
3976
    LANGUAGE sql
3977
    AS $_$
3978
SELECT util.schema_rm(schema)
3979
FROM util.schema_bundle_get_schemas($1) f (schema);
3980
SELECT NULL::void; -- don't fold away functions called in previous query
3981
$_$;
3982

    
3983

    
3984
--
3985
-- Name: schema_esc(anyelement); Type: FUNCTION; Schema: util; Owner: -
3986
--
3987

    
3988
CREATE FUNCTION schema_esc(type_null anyelement) RETURNS text
3989
    LANGUAGE sql STABLE
3990
    AS $_$
3991
SELECT quote_ident(util.schema($1))
3992
$_$;
3993

    
3994

    
3995
--
3996
-- Name: schema_matches(text, text); Type: FUNCTION; Schema: util; Owner: -
3997
--
3998

    
3999
CREATE FUNCTION schema_matches(schema text, schema_regexp text) RETURNS boolean
4000
    LANGUAGE sql IMMUTABLE
4001
    AS $_$
4002
SELECT $1 ~ $2 AND /*in userspace*/$1 !~ '^(?:information_schema|pg_.*)$'
4003
$_$;
4004

    
4005

    
4006
--
4007
-- Name: schema_oid(text); Type: FUNCTION; Schema: util; Owner: -
4008
--
4009

    
4010
CREATE FUNCTION schema_oid(schema text) RETURNS oid
4011
    LANGUAGE sql STABLE
4012
    AS $_$
4013
SELECT oid FROM pg_namespace WHERE nspname = $1
4014
$_$;
4015

    
4016

    
4017
--
4018
-- Name: schema_regexp(regclass); Type: FUNCTION; Schema: util; Owner: -
4019
--
4020

    
4021
CREATE FUNCTION schema_regexp(relation regclass) RETURNS text
4022
    LANGUAGE sql IMMUTABLE
4023
    AS $_$
4024
SELECT util.schema_regexp(schema_anchor := $1)
4025
$_$;
4026

    
4027

    
4028
--
4029
-- Name: schema_regexp(anyelement); Type: FUNCTION; Schema: util; Owner: -
4030
--
4031

    
4032
CREATE FUNCTION schema_regexp(schema_anchor anyelement) RETURNS text
4033
    LANGUAGE sql IMMUTABLE
4034
    AS $_$
4035
SELECT util.str_equality_regexp(util.schema($1))
4036
$_$;
4037

    
4038

    
4039
--
4040
-- Name: schema_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
4041
--
4042

    
4043
CREATE FUNCTION schema_rename(old text, new text) RETURNS void
4044
    LANGUAGE sql
4045
    AS $_$
4046
SELECT util.eval($$ALTER SCHEMA $$||quote_ident($1)||$$ RENAME TO $$||quote_ident($2));
4047
$_$;
4048

    
4049

    
4050
--
4051
-- Name: schema_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
4052
--
4053

    
4054
CREATE FUNCTION schema_replace(replace text, with_ text) RETURNS void
4055
    LANGUAGE plpgsql
4056
    AS $$
4057
BEGIN
4058
	-- don't schema_rm() the schema to keep!
4059
	IF replace = with_ THEN RETURN; END IF;
4060
	
4061
	PERFORM util.schema_rm(replace);
4062
	PERFORM util.schema_rename(with_, replace);
4063
END;
4064
$$;
4065

    
4066

    
4067
--
4068
-- Name: schema_rm(text); Type: FUNCTION; Schema: util; Owner: -
4069
--
4070

    
4071
CREATE FUNCTION schema_rm(schema text) RETURNS void
4072
    LANGUAGE sql
4073
    AS $_$
4074
SELECT util.eval($$DROP SCHEMA IF EXISTS $$||quote_ident($1)||$$ CASCADE$$);
4075
$_$;
4076

    
4077

    
4078
--
4079
-- Name: search_path_append(text); Type: FUNCTION; Schema: util; Owner: -
4080
--
4081

    
4082
CREATE FUNCTION search_path_append(schemas text) RETURNS void
4083
    LANGUAGE sql
4084
    AS $_$
4085
SELECT util.eval(
4086
$$SET search_path TO $$||current_setting('search_path')||$$, $$||$1);
4087
$_$;
4088

    
4089

    
4090
--
4091
-- Name: seq__create(text, integer); Type: FUNCTION; Schema: util; Owner: -
4092
--
4093

    
4094
CREATE FUNCTION seq__create(seq text, start integer DEFAULT 0) RETURNS void
4095
    LANGUAGE sql
4096
    AS $_$
4097
SELECT util.create_if_not_exists($$CREATE SEQUENCE $$||$1||$$ MINVALUE $$||$2,
4098
$1)
4099
$_$;
4100

    
4101

    
4102
--
4103
-- Name: FUNCTION seq__create(seq text, start integer); Type: COMMENT; Schema: util; Owner: -
4104
--
4105

    
4106
COMMENT ON FUNCTION seq__create(seq text, start integer) IS '
4107
idempotent
4108
';
4109

    
4110

    
4111
--
4112
-- Name: seq__reset(text, integer); Type: FUNCTION; Schema: util; Owner: -
4113
--
4114

    
4115
CREATE FUNCTION seq__reset(seq text, start integer DEFAULT 0) RETURNS void
4116
    LANGUAGE sql
4117
    AS $_$
4118
SELECT util.seq__create($1, $2);
4119
SELECT util.eval($$ALTER SEQUENCE $$||$1||$$ RESTART$$);
4120
$_$;
4121

    
4122

    
4123
--
4124
-- Name: FUNCTION seq__reset(seq text, start integer); Type: COMMENT; Schema: util; Owner: -
4125
--
4126

    
4127
COMMENT ON FUNCTION seq__reset(seq text, start integer) IS '
4128
creates sequence if doesn''t exist
4129

    
4130
idempotent
4131

    
4132
start: *note*: only used if sequence doesn''t exist
4133
';
4134

    
4135

    
4136
--
4137
-- Name: set_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
4138
--
4139

    
4140
CREATE FUNCTION set_col_names(table_ regclass, names regclass) RETURNS void
4141
    LANGUAGE plpgsql STRICT
4142
    AS $_$
4143
DECLARE
4144
    old text[] = ARRAY(SELECT util.col_names(table_));
4145
    new text[] = ARRAY(SELECT util.map_values(names));
4146
BEGIN
4147
    old = old[1:array_length(new, 1)]; -- truncate to same length
4148
    PERFORM util.eval($$ALTER TABLE $$||$1||$$ RENAME $$||quote_ident(key)
4149
||$$ TO $$||quote_ident(value))
4150
    FROM each(hstore(old, new))
4151
    WHERE value != key -- not same name
4152
    ;
4153
END;
4154
$_$;
4155

    
4156

    
4157
--
4158
-- Name: FUNCTION set_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
4159
--
4160

    
4161
COMMENT ON FUNCTION set_col_names(table_ regclass, names regclass) IS '
4162
idempotent
4163
';
4164

    
4165

    
4166
--
4167
-- Name: set_col_names_with_metadata(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
4168
--
4169

    
4170
CREATE FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) RETURNS void
4171
    LANGUAGE plpgsql STRICT
4172
    AS $_$
4173
DECLARE
4174
	row_ util.map;
4175
BEGIN
4176
	-- rename any metadata cols rather than re-adding them with new names
4177
	BEGIN
4178
		PERFORM util.set_col_names(table_, names);
4179
	EXCEPTION
4180
		WHEN array_subscript_error THEN -- selective suppress
4181
			IF SQLERRM LIKE 'arrays must have same bounds' THEN NULL;
4182
				-- metadata cols not yet added
4183
			ELSE RAISE;
4184
			END IF;
4185
	END;
4186
	
4187
	FOR row_ IN EXECUTE $$SELECT * FROM $$||names||$$ WHERE "from" LIKE ':%'$$
4188
	LOOP
4189
		PERFORM util.mk_const_col((table_, row_."to"),
4190
			substring(row_."from" from 2));
4191
	END LOOP;
4192
	
4193
	PERFORM util.set_col_names(table_, names);
4194
END;
4195
$_$;
4196

    
4197

    
4198
--
4199
-- Name: FUNCTION set_col_names_with_metadata(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
4200
--
4201

    
4202
COMMENT ON FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) IS '
4203
idempotent.
4204
the metadata mappings must be *last* in the names table.
4205
';
4206

    
4207

    
4208
--
4209
-- Name: set_col_types(regclass, col_cast[]); Type: FUNCTION; Schema: util; Owner: -
4210
--
4211

    
4212
CREATE FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) RETURNS void
4213
    LANGUAGE sql
4214
    AS $_$
4215
SELECT util.eval(COALESCE(
4216
$$ALTER TABLE $$||$1||$$
4217
$$||(
4218
	SELECT
4219
	string_agg($$ALTER COLUMN $$||col_name_sql||$$ TYPE $$||target_type
4220
	||$$ USING $$||col_name_sql||$$::$$||target_type, $$
4221
, $$)
4222
	FROM
4223
	(
4224
		SELECT
4225
		  quote_ident(col_name) AS col_name_sql
4226
		, util.col_type(($1, col_name)) AS curr_type
4227
		, type AS target_type
4228
		FROM unnest($2)
4229
	) s
4230
	WHERE curr_type != target_type
4231
), ''))
4232
$_$;
4233

    
4234

    
4235
--
4236
-- Name: FUNCTION set_col_types(table_ regclass, col_casts col_cast[]); Type: COMMENT; Schema: util; Owner: -
4237
--
4238

    
4239
COMMENT ON FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) IS '
4240
idempotent
4241
';
4242

    
4243

    
4244
--
4245
-- Name: set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
4246
--
4247

    
4248
CREATE FUNCTION set_comment(table_ regclass, comment text) RETURNS void
4249
    LANGUAGE sql
4250
    AS $_$
4251
SELECT util.eval(util.mk_set_comment($1, $2))
4252
$_$;
4253

    
4254

    
4255
--
4256
-- Name: set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
4257
--
4258

    
4259
CREATE FUNCTION set_search_path(search_path text, for_session boolean DEFAULT false) RETURNS void
4260
    LANGUAGE sql
4261
    AS $_$
4262
SELECT util.eval(util.mk_set_search_path($1, $2))
4263
$_$;
4264

    
4265

    
4266
--
4267
-- Name: show_create_view(regclass, boolean); Type: FUNCTION; Schema: util; Owner: -
4268
--
4269

    
4270
CREATE FUNCTION show_create_view(view_ regclass, replace boolean DEFAULT true) RETURNS text
4271
    LANGUAGE sql STABLE
4272
    AS $_$
4273
SELECT $$CREATE$$||(CASE WHEN $2 THEN $$ OR REPLACE$$ ELSE '' END)||$$ VIEW $$
4274
||$1||$$ AS
4275
$$||util.pg_get_viewdef($1)/*no ; because pg_get_viewdef() includes one*/||$$
4276
$$||util.mk_set_relation_metadata($1)
4277
$_$;
4278

    
4279

    
4280
--
4281
-- Name: show_grants_for(regclass); Type: FUNCTION; Schema: util; Owner: -
4282
--
4283

    
4284
CREATE FUNCTION show_grants_for(table_ regclass) RETURNS text
4285
    LANGUAGE sql STABLE
4286
    AS $_$
4287
SELECT string_agg(cmd, '')
4288
FROM
4289
(
4290
	SELECT (CASE WHEN has_table_privilege(user_, $1, 'SELECT') THEN
4291
$$GRANT SELECT ON TABLE $$||$1||$$ TO $$||quote_ident(user_)||$$;
4292
$$ ELSE '' END) AS cmd
4293
	FROM util.grants_users() f (user_)
4294
) s
4295
$_$;
4296

    
4297

    
4298
--
4299
-- Name: show_relations_like(text, text, character[]); Type: FUNCTION; Schema: util; Owner: -
4300
--
4301

    
4302
CREATE FUNCTION show_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, types character[] DEFAULT ARRAY['c'::text, 'r'::text, 'v'::text]) RETURNS SETOF regclass
4303
    LANGUAGE sql STABLE
4304
    AS $_$
4305
SELECT oid FROM pg_class
4306
WHERE relkind = ANY($3) AND relname ~ $1
4307
AND util.schema_matches(util.schema(relnamespace), $2)
4308
ORDER BY relname
4309
$_$;
4310

    
4311

    
4312
--
4313
-- Name: show_set_comment(regclass); Type: FUNCTION; Schema: util; Owner: -
4314
--
4315

    
4316
CREATE FUNCTION show_set_comment(table_ regclass) RETURNS text
4317
    LANGUAGE sql STABLE
4318
    AS $_$
4319
SELECT util.mk_set_comment($1, util.comment($1))
4320
$_$;
4321

    
4322

    
4323
--
4324
-- Name: show_types_like(text, text); Type: FUNCTION; Schema: util; Owner: -
4325
--
4326

    
4327
CREATE FUNCTION show_types_like(name_regexp text DEFAULT ''::text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regtype
4328
    LANGUAGE sql STABLE
4329
    AS $_$
4330
SELECT oid
4331
FROM pg_type
4332
WHERE typname ~ $1 AND util.schema_matches(util.schema(typnamespace), $2)
4333
ORDER BY typname
4334
$_$;
4335

    
4336

    
4337
--
4338
-- Name: show_views_like(text, text); Type: FUNCTION; Schema: util; Owner: -
4339
--
4340

    
4341
CREATE FUNCTION show_views_like(name_regexp text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regclass
4342
    LANGUAGE sql STABLE
4343
    AS $_$
4344
SELECT * FROM util.show_relations_like($1, $2, ARRAY['v'])
4345
$_$;
4346

    
4347

    
4348
--
4349
-- Name: south_america(); Type: FUNCTION; Schema: util; Owner: -
4350
--
4351

    
4352
CREATE FUNCTION south_america() RETURNS postgis.geometry
4353
    LANGUAGE sql IMMUTABLE
4354
    SET search_path TO util
4355
    AS $$
4356
SELECT util.bounding_box__no_dateline(-56 ~ 13, -82 ~ -34)
4357
$$;
4358

    
4359

    
4360
--
4361
-- Name: str_equality_regexp(text); Type: FUNCTION; Schema: util; Owner: -
4362
--
4363

    
4364
CREATE FUNCTION str_equality_regexp(literal text) RETURNS text
4365
    LANGUAGE sql IMMUTABLE
4366
    AS $_$
4367
SELECT '^'||util.regexp_quote($1)||'$'
4368
$_$;
4369

    
4370

    
4371
--
4372
-- Name: subspecies(text); Type: FUNCTION; Schema: util; Owner: -
4373
--
4374

    
4375
CREATE FUNCTION subspecies(taxon_name text) RETURNS text
4376
    LANGUAGE sql IMMUTABLE
4377
    AS $_$
4378
SELECT (regexp_matches($1, '\ysubsp\. (\S+)'))[1]
4379
$_$;
4380

    
4381

    
4382
--
4383
-- Name: table2hstore(regclass); Type: FUNCTION; Schema: util; Owner: -
4384
--
4385

    
4386
CREATE FUNCTION table2hstore(table_ regclass) RETURNS hstore
4387
    LANGUAGE plpgsql STABLE STRICT
4388
    AS $_$
4389
DECLARE
4390
    hstore hstore;
4391
BEGIN
4392
    EXECUTE $$SELECT hstore(ARRAY(SELECT unnest(ARRAY["from", "to"]) FROM $$||
4393
        table_||$$))$$ INTO STRICT hstore;
4394
    RETURN hstore;
4395
END;
4396
$_$;
4397

    
4398

    
4399
--
4400
-- Name: table_flag__get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
4401
--
4402

    
4403
CREATE FUNCTION table_flag__get(table_ regclass, flag text) RETURNS boolean
4404
    LANGUAGE sql STABLE
4405
    AS $_$
4406
SELECT COUNT(*) > 0 FROM pg_constraint
4407
WHERE conrelid = $1 AND contype = 'c' AND conname = $2
4408
$_$;
4409

    
4410

    
4411
--
4412
-- Name: FUNCTION table_flag__get(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
4413
--
4414

    
4415
COMMENT ON FUNCTION table_flag__get(table_ regclass, flag text) IS '
4416
gets whether a status flag is set by the presence of a table constraint
4417
';
4418

    
4419

    
4420
--
4421
-- Name: table_flag__set(regclass, text); Type: FUNCTION; Schema: util; Owner: -
4422
--
4423

    
4424
CREATE FUNCTION table_flag__set(table_ regclass, flag text) RETURNS void
4425
    LANGUAGE sql
4426
    AS $_$
4427
SELECT util.create_if_not_exists($$ALTER TABLE $$||$1||$$ ADD CONSTRAINT $$
4428
||quote_ident($2)||$$ CHECK (true)$$)
4429
$_$;
4430

    
4431

    
4432
--
4433
-- Name: FUNCTION table_flag__set(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
4434
--
4435

    
4436
COMMENT ON FUNCTION table_flag__set(table_ regclass, flag text) IS '
4437
stores a status flag by the presence of a table constraint.
4438
idempotent.
4439
';
4440

    
4441

    
4442
--
4443
-- Name: table_nulls_mapped__get(regclass); Type: FUNCTION; Schema: util; Owner: -
4444
--
4445

    
4446
CREATE FUNCTION table_nulls_mapped__get(table_ regclass) RETURNS boolean
4447
    LANGUAGE sql STABLE
4448
    AS $_$
4449
SELECT util.table_flag__get($1, 'nulls_mapped')
4450
$_$;
4451

    
4452

    
4453
--
4454
-- Name: FUNCTION table_nulls_mapped__get(table_ regclass); Type: COMMENT; Schema: util; Owner: -
4455
--
4456

    
4457
COMMENT ON FUNCTION table_nulls_mapped__get(table_ regclass) IS '
4458
gets whether a table''s NULL-equivalent strings have been replaced with NULL
4459
';
4460

    
4461

    
4462
--
4463
-- Name: table_nulls_mapped__set(regclass); Type: FUNCTION; Schema: util; Owner: -
4464
--
4465

    
4466
CREATE FUNCTION table_nulls_mapped__set(table_ regclass) RETURNS void
4467
    LANGUAGE sql
4468
    AS $_$
4469
SELECT util.table_flag__set($1, 'nulls_mapped')
4470
$_$;
4471

    
4472

    
4473
--
4474
-- Name: FUNCTION table_nulls_mapped__set(table_ regclass); Type: COMMENT; Schema: util; Owner: -
4475
--
4476

    
4477
COMMENT ON FUNCTION table_nulls_mapped__set(table_ regclass) IS '
4478
sets that a table''s NULL-equivalent strings have been replaced with NULL.
4479
idempotent.
4480
';
4481

    
4482

    
4483
--
4484
-- Name: to_freq(regclass); Type: FUNCTION; Schema: util; Owner: -
4485
--
4486

    
4487
CREATE FUNCTION to_freq(table_ regclass) RETURNS void
4488
    LANGUAGE sql
4489
    AS $_$
4490
-- save data before truncating main table
4491
SELECT util.copy_types_and_data($1, 'pg_temp.__copy');
4492

    
4493
-- repopulate main table w/ copies column
4494
SELECT util.truncate($1);
4495
SELECT util.eval($$ALTER TABLE $$||$1||$$ ADD COLUMN copies bigint NOT NULL$$);
4496
SELECT util.populate_table($1, $$
4497
SELECT (table_).*, copies
4498
FROM (
4499
	SELECT table_, COUNT(*) AS copies
4500
	FROM pg_temp.__copy table_
4501
	GROUP BY table_
4502
) s
4503
$$);
4504

    
4505
-- delete temp table so it doesn't stay around until end of connection
4506
SELECT util.drop_table('pg_temp.__copy');
4507
$_$;
4508

    
4509

    
4510
--
4511
-- Name: to_global_col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
4512
--
4513

    
4514
CREATE FUNCTION to_global_col_names(table_ regclass) RETURNS void
4515
    LANGUAGE plpgsql STRICT
4516
    AS $_$
4517
DECLARE
4518
    row record;
4519
BEGIN
4520
    FOR row IN SELECT * FROM util.col_global_names(table_::text::regtype)
4521
    LOOP
4522
        IF row.global_name != row.name THEN
4523
            EXECUTE $$ALTER TABLE $$||table_||$$ RENAME $$
4524
                ||quote_ident(row.name)||$$ TO $$||quote_ident(row.global_name);
4525
        END IF;
4526
    END LOOP;
4527
END;
4528
$_$;
4529

    
4530

    
4531
--
4532
-- Name: FUNCTION to_global_col_names(table_ regclass); Type: COMMENT; Schema: util; Owner: -
4533
--
4534

    
4535
COMMENT ON FUNCTION to_global_col_names(table_ regclass) IS '
4536
idempotent
4537
';
4538

    
4539

    
4540
--
4541
-- Name: trim(regclass, regclass, boolean); Type: FUNCTION; Schema: util; Owner: -
4542
--
4543

    
4544
CREATE FUNCTION "trim"(table_ regclass, names regclass, force boolean DEFAULT true) RETURNS void
4545
    LANGUAGE sql
4546
    AS $_$
4547
SELECT util.drop_column(($1, col), $3) FROM util.added_cols($1, $2) f (col);
4548
SELECT NULL::void; -- don't fold away functions called in previous query
4549
$_$;
4550

    
4551

    
4552
--
4553
-- Name: FUNCTION "trim"(table_ regclass, names regclass, force boolean); Type: COMMENT; Schema: util; Owner: -
4554
--
4555

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

    
4559
by default, cascadingly drops dependent columns so that they don''t prevent
4560
trim() from succeeding. note that this requires the dependent columns to then be
4561
manually re-created.
4562

    
4563
idempotent
4564
';
4565

    
4566

    
4567
--
4568
-- Name: truncate(regclass); Type: FUNCTION; Schema: util; Owner: -
4569
--
4570

    
4571
CREATE FUNCTION truncate(table_ regclass) RETURNS void
4572
    LANGUAGE plpgsql STRICT
4573
    AS $_$
4574
BEGIN
4575
    EXECUTE $$TRUNCATE $$||table_||$$ CASCADE$$;
4576
END;
4577
$_$;
4578

    
4579

    
4580
--
4581
-- Name: FUNCTION truncate(table_ regclass); Type: COMMENT; Schema: util; Owner: -
4582
--
4583

    
4584
COMMENT ON FUNCTION truncate(table_ regclass) IS '
4585
idempotent
4586
';
4587

    
4588

    
4589
--
4590
-- Name: truncated_prefixed_name_regexp(text, integer); Type: FUNCTION; Schema: util; Owner: -
4591
--
4592

    
4593
CREATE FUNCTION truncated_prefixed_name_regexp(name text, max_prefix_len integer) RETURNS text
4594
    LANGUAGE sql IMMUTABLE
4595
    AS $_$
4596
SELECT '^(.*)'||util._if(util.name_was_truncated($1, $2),
4597
util.regexp_quote(util.rtrim_n($1, $2))||'.*', util.regexp_quote($1)) ||'$'
4598
$_$;
4599

    
4600

    
4601
--
4602
-- Name: try_cast(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
4603
--
4604

    
4605
CREATE FUNCTION try_cast(value text, ret_type_null anyelement) RETURNS anyelement
4606
    LANGUAGE plpgsql IMMUTABLE
4607
    AS $$
4608
BEGIN
4609
	/* need explicit cast because some types not implicitly-castable, and also
4610
	to make the cast happen inside the try block. (*implicit* casts to the
4611
	return type happen at the end of the function, outside any block.) */
4612
	RETURN util.cast(value, ret_type_null);
4613
EXCEPTION
4614
WHEN   data_exception
4615
	OR invalid_schema_name -- eg. 'pg_temp.__'::regclass
4616
	OR syntax_error_or_access_rule_violation -- eg. ::regclass
4617
	THEN
4618
	PERFORM util.raise('WARNING', SQLERRM);
4619
	RETURN NULL;
4620
END;
4621
$$;
4622

    
4623

    
4624
--
4625
-- Name: FUNCTION try_cast(value text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
4626
--
4627

    
4628
COMMENT ON FUNCTION try_cast(value text, ret_type_null anyelement) IS '
4629
ret_type_null: NULL::ret_type
4630
';
4631

    
4632

    
4633
--
4634
-- Name: try_create(text); Type: FUNCTION; Schema: util; Owner: -
4635
--
4636

    
4637
CREATE FUNCTION try_create(sql text) RETURNS void
4638
    LANGUAGE plpgsql STRICT
4639
    AS $$
4640
BEGIN
4641
	PERFORM util.eval(sql);
4642
EXCEPTION
4643
WHEN   not_null_violation
4644
		/* trying to add NOT NULL column to parent table, which cascades to
4645
		child table whose values for the new column will be NULL */
4646
	OR wrong_object_type -- trying to alter a view's columns
4647
	OR undefined_column
4648
	OR duplicate_column
4649
THEN NULL;
4650
WHEN datatype_mismatch THEN
4651
	IF SQLERRM LIKE 'child table is missing column %' THEN NULL;
4652
	ELSE RAISE; -- rethrow
4653
	END IF;
4654
END;
4655
$$;
4656

    
4657

    
4658
--
4659
-- Name: FUNCTION try_create(sql text); Type: COMMENT; Schema: util; Owner: -
4660
--
4661

    
4662
COMMENT ON FUNCTION try_create(sql text) IS '
4663
idempotent
4664
';
4665

    
4666

    
4667
--
4668
-- Name: try_mk_derived_col(col_ref, text); Type: FUNCTION; Schema: util; Owner: -
4669
--
4670

    
4671
CREATE FUNCTION try_mk_derived_col(col col_ref, expr text) RETURNS void
4672
    LANGUAGE sql
4673
    AS $_$
4674
SELECT util.try_create($$SELECT util.mk_derived_col($$||quote_literal($1)||$$, $$||quote_literal($2)||$$)$$)
4675
$_$;
4676

    
4677

    
4678
--
4679
-- Name: FUNCTION try_mk_derived_col(col col_ref, expr text); Type: COMMENT; Schema: util; Owner: -
4680
--
4681

    
4682
COMMENT ON FUNCTION try_mk_derived_col(col col_ref, expr text) IS '
4683
idempotent
4684
';
4685

    
4686

    
4687
--
4688
-- Name: type_qual(anyelement); Type: FUNCTION; Schema: util; Owner: -
4689
--
4690

    
4691
CREATE FUNCTION type_qual(value anyelement) RETURNS text
4692
    LANGUAGE sql IMMUTABLE
4693
    AS $_$
4694
SELECT CASE WHEN $1 IS NULL THEN '' ELSE $$ NOT NULL$$ END
4695
$_$;
4696

    
4697

    
4698
--
4699
-- Name: FUNCTION type_qual(value anyelement); Type: COMMENT; Schema: util; Owner: -
4700
--
4701

    
4702
COMMENT ON FUNCTION type_qual(value anyelement) IS '
4703
a type''s NOT NULL qualifier
4704
';
4705

    
4706

    
4707
--
4708
-- Name: typed_cols(regtype); Type: FUNCTION; Schema: util; Owner: -
4709
--
4710

    
4711
CREATE FUNCTION typed_cols(type regtype) RETURNS SETOF col_cast
4712
    LANGUAGE sql STABLE
4713
    AS $_$
4714
SELECT (attname::text, atttypid)::util.col_cast
4715
FROM pg_attribute
4716
WHERE attrelid = $1::text::regclass AND attnum >= 1 AND NOT attisdropped
4717
ORDER BY attnum
4718
$_$;
4719

    
4720

    
4721
--
4722
-- Name: typeof(anyelement); Type: FUNCTION; Schema: util; Owner: -
4723
--
4724

    
4725
CREATE FUNCTION typeof(value anyelement) RETURNS text
4726
    LANGUAGE sql IMMUTABLE
4727
    AS $_$
4728
SELECT util.qual_name(pg_typeof($1))
4729
$_$;
4730

    
4731

    
4732
--
4733
-- Name: typeof(text, regtype); Type: FUNCTION; Schema: util; Owner: -
4734
--
4735

    
4736
CREATE FUNCTION typeof(expr text, table_ regtype DEFAULT NULL::regtype) RETURNS regtype
4737
    LANGUAGE plpgsql STABLE
4738
    AS $_$
4739
DECLARE
4740
    type regtype;
4741
BEGIN
4742
    EXECUTE $$SELECT pg_typeof($$||expr||$$)$$||
4743
COALESCE($$ FROM (SELECT (NULL::$$||table_||$$).*) _s$$, '') INTO STRICT type;
4744
    RETURN type;
4745
END;
4746
$_$;
4747

    
4748

    
4749
--
4750
-- Name: use_schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
4751
--
4752

    
4753
CREATE FUNCTION use_schema(schema_anchor anyelement) RETURNS void
4754
    LANGUAGE sql
4755
    AS $_$
4756
SELECT util.set_search_path(util.mk_search_path(util.schema($1)))
4757
$_$;
4758

    
4759

    
4760
--
4761
-- Name: FUNCTION use_schema(schema_anchor anyelement); Type: COMMENT; Schema: util; Owner: -
4762
--
4763

    
4764
COMMENT ON FUNCTION use_schema(schema_anchor anyelement) IS '
4765
auto-appends util to the search_path to enable use of util operators
4766
';
4767

    
4768

    
4769
--
4770
-- Name: view_def_to_orig(text); Type: FUNCTION; Schema: util; Owner: -
4771
--
4772

    
4773
CREATE FUNCTION view_def_to_orig(view_def text) RETURNS text
4774
    LANGUAGE sql IMMUTABLE
4775
    AS $_$
4776
SELECT CASE
4777
WHEN util.view_is_subset($1) THEN $1
4778
	-- list of cols from the same table is not an expanded * expression
4779
ELSE
4780
regexp_replace(
4781
regexp_replace(
4782
$1
4783
,
4784
/* unexpand expanded * expressions. any list of 6+ cols from the same table is
4785
treated as a * expression. */
4786
'((?:"[^"\s]+"|\w+)\.)(?:"[^"\s]+"|\w+)'||
4787
	/* 1st col, which lacks separator before.
4788
	*note*: can't prepend \y because it considers only \w chars, not " */
4789
'(,[[:blank:]]*
4790
[[:blank:]]*)\1(?:"[^"\s]+"|\w+)'|| -- 2nd col, which has separator before
4791
'(?:\2\1(?:"[^"\s]+"|\w+)){4,}', -- later cols, w/ same table name and separator
4792
'\1*'/*prefix w/ table*/,
4793
'g')
4794
,
4795
/* merge .* expressions resulting from a SELECT * of a join. any list of
4796
multiple .* expressions is treated as a SELECT * . */
4797
'(?:"[^"\s]+"|\w+)\.\*'||
4798
	/* 1st table, which lacks separator before.
4799
	*note*: can't prepend \y because it considers only \w chars, not " */
4800
'(,[[:blank:]]*
4801
[[:blank:]]*)(?:"[^"\s]+"|\w+)\.\*'|| -- 2nd table, which has separator before
4802
'(?:\1(?:"[^"\s]+"|\w+)\.\*)*', -- later tables, w/ same separator
4803
'*',
4804
'g')
4805
END
4806
$_$;
4807

    
4808

    
4809
--
4810
-- Name: view_is_automatically_updatable(text); Type: FUNCTION; Schema: util; Owner: -
4811
--
4812

    
4813
CREATE FUNCTION view_is_automatically_updatable(view_def text) RETURNS boolean
4814
    LANGUAGE sql IMMUTABLE
4815
    AS $_$
4816
SELECT $1 !~ '\y(?:JOIN|WITH|DISTINCT|GROUP BY|HAVING|LIMIT|OFFSET)\y'
4817
	/* from http://www.postgresql.org/docs/9.3/static/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS */
4818
$_$;
4819

    
4820

    
4821
--
4822
-- Name: view_is_subset(text); Type: FUNCTION; Schema: util; Owner: -
4823
--
4824

    
4825
CREATE FUNCTION view_is_subset(view_def text) RETURNS boolean
4826
    LANGUAGE sql IMMUTABLE
4827
    AS $_$
4828
SELECT util.view_is_automatically_updatable($1)
4829
$_$;
4830

    
4831

    
4832
--
4833
-- Name: all_same(anyelement); Type: AGGREGATE; Schema: util; Owner: -
4834
--
4835

    
4836
CREATE AGGREGATE all_same(anyelement) (
4837
    SFUNC = all_same_transform,
4838
    STYPE = anyarray,
4839
    FINALFUNC = all_same_final
4840
);
4841

    
4842

    
4843
--
4844
-- Name: AGGREGATE all_same(anyelement); Type: COMMENT; Schema: util; Owner: -
4845
--
4846

    
4847
COMMENT ON AGGREGATE all_same(anyelement) IS '
4848
includes NULLs in comparison
4849
';
4850

    
4851

    
4852
--
4853
-- Name: join_strs(text, text); Type: AGGREGATE; Schema: util; Owner: -
4854
--
4855

    
4856
CREATE AGGREGATE join_strs(text, text) (
4857
    SFUNC = join_strs_transform,
4858
    STYPE = text
4859
);
4860

    
4861

    
4862
--
4863
-- Name: %==; Type: OPERATOR; Schema: util; Owner: -
4864
--
4865

    
4866
CREATE OPERATOR %== (
4867
    PROCEDURE = keys_eq,
4868
    LEFTARG = anyelement,
4869
    RIGHTARG = anyelement
4870
);
4871

    
4872

    
4873
--
4874
-- Name: OPERATOR %== (anyelement, anyelement); Type: COMMENT; Schema: util; Owner: -
4875
--
4876

    
4877
COMMENT ON OPERATOR %== (anyelement, anyelement) IS '
4878
returns whether the map-keys of the compared values are the same
4879
(mnemonic: % is the Perl symbol for a hash map)
4880

    
4881
should be overridden for types that store both keys and values
4882

    
4883
used in a FULL JOIN to select which columns to join on
4884
';
4885

    
4886

    
4887
--
4888
-- Name: ->; Type: OPERATOR; Schema: util; Owner: -
4889
--
4890

    
4891
CREATE OPERATOR -> (
4892
    PROCEDURE = map_get,
4893
    LEFTARG = regclass,
4894
    RIGHTARG = text
4895
);
4896

    
4897

    
4898
--
4899
-- Name: =>; Type: OPERATOR; Schema: util; Owner: -
4900
--
4901

    
4902
CREATE OPERATOR => (
4903
    PROCEDURE = hstore,
4904
    LEFTARG = text[],
4905
    RIGHTARG = text
4906
);
4907

    
4908

    
4909
--
4910
-- Name: OPERATOR => (text[], text); Type: COMMENT; Schema: util; Owner: -
4911
--
4912

    
4913
COMMENT ON OPERATOR => (text[], text) IS '
4914
usage: array[''key1'', ...]::text[] => ''value''
4915
';
4916

    
4917

    
4918
--
4919
-- Name: ?*>=; Type: OPERATOR; Schema: util; Owner: -
4920
--
4921

    
4922
CREATE OPERATOR ?*>= (
4923
    PROCEDURE = is_populated_more_often_than,
4924
    LEFTARG = anyelement,
4925
    RIGHTARG = anyelement
4926
);
4927

    
4928

    
4929
--
4930
-- Name: ?>=; Type: OPERATOR; Schema: util; Owner: -
4931
--
4932

    
4933
CREATE OPERATOR ?>= (
4934
    PROCEDURE = is_more_complete_than,
4935
    LEFTARG = anyelement,
4936
    RIGHTARG = anyelement
4937
);
4938

    
4939

    
4940
--
4941
-- Name: @; Type: OPERATOR; Schema: util; Owner: -
4942
--
4943

    
4944
CREATE OPERATOR @ (
4945
    PROCEDURE = contained_within__no_dateline,
4946
    LEFTARG = postgis.geometry,
4947
    RIGHTARG = postgis.geometry
4948
);
4949

    
4950

    
4951
--
4952
-- Name: @; Type: OPERATOR; Schema: util; Owner: -
4953
--
4954

    
4955
CREATE OPERATOR @ (
4956
    PROCEDURE = contained_within__no_dateline,
4957
    LEFTARG = geocoord,
4958
    RIGHTARG = postgis.geometry
4959
);
4960

    
4961

    
4962
--
4963
-- Name: ||%; Type: OPERATOR; Schema: util; Owner: -
4964
--
4965

    
4966
CREATE OPERATOR ||% (
4967
    PROCEDURE = concat_esc,
4968
    LEFTARG = text,
4969
    RIGHTARG = text
4970
);
4971

    
4972

    
4973
--
4974
-- Name: OPERATOR ||% (text, text); Type: COMMENT; Schema: util; Owner: -
4975
--
4976

    
4977
COMMENT ON OPERATOR ||% (text, text) IS '
4978
% indicates an identifier, as in Perl hashes and one of the x86 assembler syntaxes for registers
4979
';
4980

    
4981

    
4982
--
4983
-- Name: ~; Type: OPERATOR; Schema: util; Owner: -
4984
--
4985

    
4986
CREATE OPERATOR ~ (
4987
    PROCEDURE = range,
4988
    LEFTARG = numeric,
4989
    RIGHTARG = numeric
4990
);
4991

    
4992

    
4993
--
4994
-- Name: ~@; Type: OPERATOR; Schema: util; Owner: -
4995
--
4996

    
4997
CREATE OPERATOR ~@ (
4998
    PROCEDURE = contained_within_approx,
4999
    LEFTARG = postgis.geography,
5000
    RIGHTARG = postgis.geography
5001
);
5002

    
5003

    
5004
--
5005
-- Name: OPERATOR ~@ (postgis.geography, postgis.geography); Type: COMMENT; Schema: util; Owner: -
5006
--
5007

    
5008
COMMENT ON OPERATOR ~@ (postgis.geography, postgis.geography) IS '
5009
can''t use && because it only compares 2D bounding boxes (which are geometry
5010
objects that do not support geocoordinate wraparound)
5011
';
5012

    
5013

    
5014
--
5015
-- Name: ~@; Type: OPERATOR; Schema: util; Owner: -
5016
--
5017

    
5018
CREATE OPERATOR ~@ (
5019
    PROCEDURE = contained_within_approx,
5020
    LEFTARG = geocoord,
5021
    RIGHTARG = postgis.geography
5022
);
5023

    
5024

    
5025
SET search_path = pg_catalog;
5026

    
5027
--
5028
-- Name: CAST (util.range AS numrange); Type: CAST; Schema: pg_catalog; Owner: -
5029
--
5030

    
5031
CREATE CAST (util.range AS numrange) WITH FUNCTION util.numrange(util.range) AS IMPLICIT;
5032

    
5033

    
5034
SET search_path = util, pg_catalog;
5035

    
5036
--
5037
-- Name: map; Type: TABLE; Schema: util; Owner: -; Tablespace: 
5038
--
5039

    
5040
CREATE TABLE map (
5041
    "from" text NOT NULL,
5042
    "to" text,
5043
    filter text,
5044
    notes text
5045
);
5046

    
5047

    
5048
--
5049
-- Data for Name: explain; Type: TABLE DATA; Schema: util; Owner: -
5050
--
5051

    
5052

    
5053

    
5054
--
5055
-- Data for Name: map; Type: TABLE DATA; Schema: util; Owner: -
5056
--
5057

    
5058

    
5059

    
5060
--
5061
-- Name: map__unique__from; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
5062
--
5063

    
5064
ALTER TABLE ONLY map
5065
    ADD CONSTRAINT map__unique__from UNIQUE ("from");
5066

    
5067

    
5068
--
5069
-- Name: map__unique__to; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace: 
5070
--
5071

    
5072
ALTER TABLE ONLY map
5073
    ADD CONSTRAINT map__unique__to UNIQUE ("to");
5074

    
5075

    
5076
--
5077
-- Name: map_filter_insert; Type: TRIGGER; Schema: util; Owner: -
5078
--
5079

    
5080
CREATE TRIGGER map_filter_insert BEFORE INSERT ON map FOR EACH ROW EXECUTE PROCEDURE map_filter_insert();
5081

    
5082

    
5083
--
5084
-- PostgreSQL database dump complete
5085
--
5086

    
(21-21/31)