Skip to content

Commit 62e6664

Browse files
tglsfdctglsfdc
committed
Perform line wrapping and indenting by default in ruleutils.c.
This patch changes pg_get_viewdef() and allied functions so that PRETTY_INDENT processing is always enabled. Per discussion, only the PRETTY_PAREN processing (that is, stripping of "unnecessary" parentheses) poses any real forward-compatibility risk, so we may as well make dump output look as nice as we safely can. Also, set the default wrap length to zero (i.e, wrap after each SELECT or FROM list item), since there's no very principled argument for the former default of 80-column wrapping, and most people seem to agree this way looks better. Marko Tiikkaja, reviewed by Jeevan Chalke, further hacking by Tom Lane
1 parent 330ed4a commit 62e6664

File tree

12 files changed

+1496
-348
lines changed

12 files changed

+1496
-348
lines changed

‎doc/src/sgml/func.sgml‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13872,8 +13872,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
1387213872
<row>
1387313873
<entry><literal><function>pg_get_viewdef(<parameter>view_name</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
1387413874
<entry><type>text</type></entry>
13875-
<entry>get underlying <command>SELECT</command> command for view;
13876-
lines with fields are wrapped to 80 columns if <parameter>pretty_bool</parameter> is true (<emphasis>deprecated</emphasis>)</entry>
13875+
<entry>get underlying <command>SELECT</command> command for view (<emphasis>deprecated</emphasis>)</entry>
1387713876
</row>
1387813877
<row>
1387913878
<entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>)</function></literal></entry>
@@ -13883,15 +13882,14 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
1388313882
<row>
1388413883
<entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
1388513884
<entry><type>text</type></entry>
13886-
<entry>get underlying <command>SELECT</command> command for view;
13887-
lines with fields are wrapped to 80 columns if <parameter>pretty_bool</parameter> is true</entry>
13885+
<entry>get underlying <command>SELECT</command> command for view</entry>
1388813886
</row>
1388913887
<row>
1389013888
<entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>, <parameter>wrap_column_int</>)</function></literal></entry>
1389113889
<entry><type>text</type></entry>
1389213890
<entry>get underlying <command>SELECT</command> command for view;
1389313891
lines with fields are wrapped to specified number of columns,
13894-
pretty printing is implied</entry>
13892+
pretty-printing is implied</entry>
1389513893
</row>
1389613894
<row>
1389713895
<entry><literal><function>pg_options_to_table(<parameter>reloptions</parameter>)</function></literal></entry>

‎src/backend/utils/adt/ruleutils.c‎

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@
7474
#define PRETTYFLAG_PAREN 1
7575
#define PRETTYFLAG_INDENT 2
7676

77-
/* Default line length for pretty-print wrapping */
78-
#define WRAP_COLUMN_DEFAULT 79
77+
/* Default line length for pretty-print wrapping: 0 means wrap always */
78+
#define WRAP_COLUMN_DEFAULT 0
7979

8080
/* macro to test if pretty action needed */
8181
#define PRETTY_PAREN(context) ((context)->prettyFlags & PRETTYFLAG_PAREN)
@@ -416,8 +416,10 @@ Datum
416416
pg_get_ruledef(PG_FUNCTION_ARGS)
417417
{
418418
Oid ruleoid = PG_GETARG_OID(0);
419+
int prettyFlags;
419420

420-
PG_RETURN_TEXT_P(string_to_text(pg_get_ruledef_worker(ruleoid, 0)));
421+
prettyFlags = PRETTYFLAG_INDENT;
422+
PG_RETURN_TEXT_P(string_to_text(pg_get_ruledef_worker(ruleoid, prettyFlags)));
421423
}
422424

423425

@@ -428,7 +430,7 @@ pg_get_ruledef_ext(PG_FUNCTION_ARGS)
428430
bool pretty = PG_GETARG_BOOL(1);
429431
int prettyFlags;
430432

431-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
433+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
432434
PG_RETURN_TEXT_P(string_to_text(pg_get_ruledef_worker(ruleoid, prettyFlags)));
433435
}
434436

@@ -512,8 +514,10 @@ pg_get_viewdef(PG_FUNCTION_ARGS)
512514
{
513515
/* By OID */
514516
Oid viewoid = PG_GETARG_OID(0);
517+
int prettyFlags;
515518

516-
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, 0, -1)));
519+
prettyFlags = PRETTYFLAG_INDENT;
520+
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, prettyFlags, WRAP_COLUMN_DEFAULT)));
517521
}
518522

519523

@@ -525,7 +529,7 @@ pg_get_viewdef_ext(PG_FUNCTION_ARGS)
525529
bool pretty = PG_GETARG_BOOL(1);
526530
int prettyFlags;
527531

528-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
532+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
529533
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, prettyFlags, WRAP_COLUMN_DEFAULT)));
530534
}
531535

@@ -536,27 +540,28 @@ pg_get_viewdef_wrap(PG_FUNCTION_ARGS)
536540
Oid viewoid = PG_GETARG_OID(0);
537541
int wrap = PG_GETARG_INT32(1);
538542
int prettyFlags;
539-
char *result;
540543

541544
/* calling this implies we want pretty printing */
542545
prettyFlags = PRETTYFLAG_PAREN | PRETTYFLAG_INDENT;
543-
result = pg_get_viewdef_worker(viewoid, prettyFlags, wrap);
544-
PG_RETURN_TEXT_P(string_to_text(result));
546+
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, prettyFlags, wrap)));
545547
}
546548

547549
Datum
548550
pg_get_viewdef_name(PG_FUNCTION_ARGS)
549551
{
550552
/* By qualified name */
551553
text *viewname = PG_GETARG_TEXT_P(0);
554+
int prettyFlags;
552555
RangeVar *viewrel;
553556
Oid viewoid;
554557

558+
prettyFlags = PRETTYFLAG_INDENT;
559+
555560
/* Look up view name. Can't lock it - we might not have privileges. */
556561
viewrel = makeRangeVarFromNameList(textToQualifiedNameList(viewname));
557562
viewoid = RangeVarGetRelid(viewrel, NoLock, false);
558563

559-
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, 0, -1)));
564+
PG_RETURN_TEXT_P(string_to_text(pg_get_viewdef_worker(viewoid, prettyFlags, WRAP_COLUMN_DEFAULT)));
560565
}
561566

562567

@@ -570,7 +575,7 @@ pg_get_viewdef_name_ext(PG_FUNCTION_ARGS)
570575
RangeVar *viewrel;
571576
Oid viewoid;
572577

573-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
578+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
574579

575580
/* Look up view name. Can't lock it - we might not have privileges. */
576581
viewrel = makeRangeVarFromNameList(textToQualifiedNameList(viewname));
@@ -848,7 +853,7 @@ pg_get_triggerdef_worker(Oid trigid, bool pretty)
848853
context.windowClause = NIL;
849854
context.windowTList = NIL;
850855
context.varprefix = true;
851-
context.prettyFlags = pretty ? PRETTYFLAG_PAREN : 0;
856+
context.prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
852857
context.wrapColumn = WRAP_COLUMN_DEFAULT;
853858
context.indentLevel = PRETTYINDENT_STD;
854859

@@ -911,10 +916,13 @@ Datum
911916
pg_get_indexdef(PG_FUNCTION_ARGS)
912917
{
913918
Oid indexrelid = PG_GETARG_OID(0);
919+
int prettyFlags;
914920

921+
prettyFlags = PRETTYFLAG_INDENT;
915922
PG_RETURN_TEXT_P(string_to_text(pg_get_indexdef_worker(indexrelid, 0,
916923
NULL,
917-
false, false, 0)));
924+
false, false,
925+
prettyFlags)));
918926
}
919927

920928
Datum
@@ -925,15 +933,15 @@ pg_get_indexdef_ext(PG_FUNCTION_ARGS)
925933
bool pretty = PG_GETARG_BOOL(2);
926934
int prettyFlags;
927935

928-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
936+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
929937
PG_RETURN_TEXT_P(string_to_text(pg_get_indexdef_worker(indexrelid, colno,
930938
NULL,
931939
colno != 0,
932940
false,
933941
prettyFlags)));
934942
}
935943

936-
/* Internal version that returns a palloc'd C string */
944+
/* Internal version that returns a palloc'd C string; no pretty-printing */
937945
char *
938946
pg_get_indexdef_string(Oid indexrelid)
939947
{
@@ -946,7 +954,7 @@ pg_get_indexdef_columns(Oid indexrelid, bool pretty)
946954
{
947955
int prettyFlags;
948956

949-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
957+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
950958
return pg_get_indexdef_worker(indexrelid, 0, NULL, true, false, prettyFlags);
951959
}
952960

@@ -1245,9 +1253,12 @@ Datum
12451253
pg_get_constraintdef(PG_FUNCTION_ARGS)
12461254
{
12471255
Oid constraintId = PG_GETARG_OID(0);
1256+
int prettyFlags;
12481257

1258+
prettyFlags = PRETTYFLAG_INDENT;
12491259
PG_RETURN_TEXT_P(string_to_text(pg_get_constraintdef_worker(constraintId,
1250-
false, 0)));
1260+
false,
1261+
prettyFlags)));
12511262
}
12521263

12531264
Datum
@@ -1257,12 +1268,13 @@ pg_get_constraintdef_ext(PG_FUNCTION_ARGS)
12571268
bool pretty = PG_GETARG_BOOL(1);
12581269
int prettyFlags;
12591270

1260-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
1271+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
12611272
PG_RETURN_TEXT_P(string_to_text(pg_get_constraintdef_worker(constraintId,
1262-
false, prettyFlags)));
1273+
false,
1274+
prettyFlags)));
12631275
}
12641276

1265-
/* Internal version that returns a palloc'd C string */
1277+
/* Internal version that returns a palloc'd C string; no pretty-printing */
12661278
char *
12671279
pg_get_constraintdef_string(Oid constraintId)
12681280
{
@@ -1615,8 +1627,11 @@ pg_get_expr(PG_FUNCTION_ARGS)
16151627
{
16161628
text *expr = PG_GETARG_TEXT_P(0);
16171629
Oid relid = PG_GETARG_OID(1);
1630+
int prettyFlags;
16181631
char *relname;
16191632

1633+
prettyFlags = PRETTYFLAG_INDENT;
1634+
16201635
if (OidIsValid(relid))
16211636
{
16221637
/* Get the name for the relation */
@@ -1634,7 +1649,7 @@ pg_get_expr(PG_FUNCTION_ARGS)
16341649
else
16351650
relname = NULL;
16361651

1637-
PG_RETURN_TEXT_P(pg_get_expr_worker(expr, relid, relname, 0));
1652+
PG_RETURN_TEXT_P(pg_get_expr_worker(expr, relid, relname, prettyFlags));
16381653
}
16391654

16401655
Datum
@@ -1646,7 +1661,7 @@ pg_get_expr_ext(PG_FUNCTION_ARGS)
16461661
int prettyFlags;
16471662
char *relname;
16481663

1649-
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : 0;
1664+
prettyFlags = pretty ? PRETTYFLAG_PAREN | PRETTYFLAG_INDENT : PRETTYFLAG_INDENT;
16501665

16511666
if (OidIsValid(relid))
16521667
{

‎src/test/regress/expected/aggregates.out‎

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -943,9 +943,10 @@ select * from agg_view1;
943943
(1 row)
944944

945945
select pg_get_viewdef('agg_view1'::regclass);
946-
pg_get_viewdef
947-
--------------------------------------------------------------------------------------------------------------------------------------------------------
948-
SELECT aggfns(v.a, v.b, v.c) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
946+
pg_get_viewdef
947+
---------------------------------------------------------------------------------------------------------------------
948+
SELECT aggfns(v.a, v.b, v.c) AS aggfns +
949+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
949950
(1 row)
950951

951952
create or replace view agg_view1 as
@@ -959,9 +960,11 @@ select * from agg_view1;
959960
(1 row)
960961

961962
select pg_get_viewdef('agg_view1'::regclass);
962-
pg_get_viewdef
963-
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
964-
SELECT aggfns(DISTINCT v.a, v.b, v.c) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), generate_series(1, 3) i(i);
963+
pg_get_viewdef
964+
----------------------------------------------------------------------------------------------------------------------
965+
SELECT aggfns(DISTINCT v.a, v.b, v.c) AS aggfns +
966+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), +
967+
generate_series(1, 3) i(i);
965968
(1 row)
966969

967970
create or replace view agg_view1 as
@@ -975,9 +978,11 @@ select * from agg_view1;
975978
(1 row)
976979

977980
select pg_get_viewdef('agg_view1'::regclass);
978-
pg_get_viewdef
979-
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
980-
SELECT aggfns(DISTINCT v.a, v.b, v.c ORDER BY v.b) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), generate_series(1, 3) i(i);
981+
pg_get_viewdef
982+
----------------------------------------------------------------------------------------------------------------------
983+
SELECT aggfns(DISTINCT v.a, v.b, v.c ORDER BY v.b) AS aggfns +
984+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), +
985+
generate_series(1, 3) i(i);
981986
(1 row)
982987

983988
create or replace view agg_view1 as
@@ -990,9 +995,10 @@ select * from agg_view1;
990995
(1 row)
991996

992997
select pg_get_viewdef('agg_view1'::regclass);
993-
pg_get_viewdef
994-
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
995-
SELECT aggfns(v.a, v.b, v.c ORDER BY (v.b + 1)) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
998+
pg_get_viewdef
999+
---------------------------------------------------------------------------------------------------------------------
1000+
SELECT aggfns(v.a, v.b, v.c ORDER BY (v.b + 1)) AS aggfns +
1001+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
9961002
(1 row)
9971003

9981004
create or replace view agg_view1 as
@@ -1005,9 +1011,10 @@ select * from agg_view1;
10051011
(1 row)
10061012

10071013
select pg_get_viewdef('agg_view1'::regclass);
1008-
pg_get_viewdef
1009-
---------------------------------------------------------------------------------------------------------------------------------------------------------------------
1010-
SELECT aggfns(v.a, v.a, v.c ORDER BY v.b) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
1014+
pg_get_viewdef
1015+
---------------------------------------------------------------------------------------------------------------------
1016+
SELECT aggfns(v.a, v.a, v.c ORDER BY v.b) AS aggfns +
1017+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
10111018
(1 row)
10121019

10131020
create or replace view agg_view1 as
@@ -1020,9 +1027,10 @@ select * from agg_view1;
10201027
(1 row)
10211028

10221029
select pg_get_viewdef('agg_view1'::regclass);
1023-
pg_get_viewdef
1024-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1025-
SELECT aggfns(v.a, v.b, v.c ORDER BY v.c USING ~<~ NULLS LAST) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
1030+
pg_get_viewdef
1031+
---------------------------------------------------------------------------------------------------------------------
1032+
SELECT aggfns(v.a, v.b, v.c ORDER BY v.c USING ~<~ NULLS LAST) AS aggfns +
1033+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c);
10261034
(1 row)
10271035

10281036
create or replace view agg_view1 as
@@ -1036,9 +1044,11 @@ select * from agg_view1;
10361044
(1 row)
10371045

10381046
select pg_get_viewdef('agg_view1'::regclass);
1039-
pg_get_viewdef
1040-
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1041-
SELECT aggfns(DISTINCT v.a, v.b, v.c ORDER BY v.a, v.c USING ~<~ NULLS LAST, v.b) AS aggfns FROM (VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), generate_series(1, 2) i(i);
1047+
pg_get_viewdef
1048+
----------------------------------------------------------------------------------------------------------------------
1049+
SELECT aggfns(DISTINCT v.a, v.b, v.c ORDER BY v.a, v.c USING ~<~ NULLS LAST, v.b) AS aggfns +
1050+
FROM ( VALUES (1,3,'foo'::text), (0,NULL::integer,NULL::text), (2,2,'bar'::text), (3,1,'baz'::text)) v(a, b, c), +
1051+
generate_series(1, 2) i(i);
10421052
(1 row)
10431053

10441054
drop view agg_view1;

‎src/test/regress/expected/collate.out‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -194,11 +194,19 @@ CREATE VIEW collview2 AS SELECT a, b FROM collate_test1 ORDER BY b COLLATE "C";
194194
CREATE VIEW collview3 AS SELECT a, lower((x || x) COLLATE "POSIX") FROM collate_test10;
195195
SELECT table_name, view_definition FROM information_schema.views
196196
WHERE table_name LIKE 'collview%' ORDER BY 1;
197-
table_name | view_definition
198-
------------+------------------------------------------------------------------------------------------------------------------------
199-
collview1 | SELECT collate_test1.a, collate_test1.b FROM collate_test1 WHERE ((collate_test1.b COLLATE "C") >= 'bbc'::text);
200-
collview2 | SELECT collate_test1.a, collate_test1.b FROM collate_test1 ORDER BY (collate_test1.b COLLATE "C");
201-
collview3 | SELECT collate_test10.a, lower(((collate_test10.x || collate_test10.x) COLLATE "POSIX")) AS lower FROM collate_test10;
197+
table_name | view_definition
198+
------------+------------------------------------------------------------------------------
199+
collview1 | SELECT collate_test1.a, +
200+
| collate_test1.b +
201+
| FROM collate_test1 +
202+
| WHERE ((collate_test1.b COLLATE "C") >= 'bbc'::text);
203+
collview2 | SELECT collate_test1.a, +
204+
| collate_test1.b +
205+
| FROM collate_test1 +
206+
| ORDER BY (collate_test1.b COLLATE "C");
207+
collview3 | SELECT collate_test10.a, +
208+
| lower(((collate_test10.x || collate_test10.x) COLLATE "POSIX")) AS lower+
209+
| FROM collate_test10;
202210
(3 rows)
203211

204212
-- collation propagation in various expression types

0 commit comments

Comments
 (0)