Skip to content

Commit 0d82970

Browse files
hlinnakahlinnaka
committed
docs: Consistently use <optional> to indicate optional parameters
Some functions were using square brackets instead, replace them all with <optional>. Author: Dagfinn Ilmari Mannsåker <[email protected]> Reviewed-by: jian he <[email protected]> Discussion: https://www.postgresql.org/message-id/flat/CACJufxFfUbSph5UUSsZbL4SitbuPuW%[email protected]
1 parent b6558e4 commit 0d82970

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

‎doc/src/sgml/func.sgml‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3036,7 +3036,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
30363036
<primary>concat</primary>
30373037
</indexterm>
30383038
<function>concat</function> ( <parameter>val1</parameter> <type>"any"</type>
3039-
[, <parameter>val2</parameter> <type>"any"</type> [, ...] ] )
3039+
<optional>, <parameter>val2</parameter> <type>"any"</type> <optional>, ...</optional> </optional> )
30403040
<returnvalue>text</returnvalue>
30413041
</para>
30423042
<para>
@@ -3056,7 +3056,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
30563056
</indexterm>
30573057
<function>concat_ws</function> ( <parameter>sep</parameter> <type>text</type>,
30583058
<parameter>val1</parameter> <type>"any"</type>
3059-
[, <parameter>val2</parameter> <type>"any"</type> [, ...] ] )
3059+
<optional>, <parameter>val2</parameter> <type>"any"</type> <optional>, ...</optional> </optional> )
30603060
<returnvalue>text</returnvalue>
30613061
</para>
30623062
<para>
@@ -3076,7 +3076,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
30763076
<primary>format</primary>
30773077
</indexterm>
30783078
<function>format</function> ( <parameter>formatstr</parameter> <type>text</type>
3079-
[, <parameter>formatarg</parameter> <type>"any"</type> [, ...] ] )
3079+
<optional>, <parameter>formatarg</parameter> <type>"any"</type> <optional>, ...</optional> </optional> )
30803080
<returnvalue>text</returnvalue>
30813081
</para>
30823082
<para>
@@ -3170,7 +3170,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
31703170
<primary>parse_ident</primary>
31713171
</indexterm>
31723172
<function>parse_ident</function> ( <parameter>qualified_identifier</parameter> <type>text</type>
3173-
[, <parameter>strict_mode</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>true</literal> ] )
3173+
<optional>, <parameter>strict_mode</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>true</literal> </optional> )
31743174
<returnvalue>text[]</returnvalue>
31753175
</para>
31763176
<para>
@@ -3309,8 +3309,8 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
33093309
<primary>regexp_count</primary>
33103310
</indexterm>
33113311
<function>regexp_count</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>
3312-
[, <parameter>start</parameter> <type>integer</type>
3313-
[, <parameter>flags</parameter> <type>text</type> ] ] )
3312+
<optional>, <parameter>start</parameter> <type>integer</type>
3313+
<optional>, <parameter>flags</parameter> <type>text</type> </optional> </optional> )
33143314
<returnvalue>integer</returnvalue>
33153315
</para>
33163316
<para>
@@ -3331,11 +3331,11 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
33313331
<primary>regexp_instr</primary>
33323332
</indexterm>
33333333
<function>regexp_instr</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>
3334-
[, <parameter>start</parameter> <type>integer</type>
3335-
[, <parameter>N</parameter> <type>integer</type>
3336-
[, <parameter>endoption</parameter> <type>integer</type>
3337-
[, <parameter>flags</parameter> <type>text</type>
3338-
[, <parameter>subexpr</parameter> <type>integer</type> ] ] ] ] ] )
3334+
<optional>, <parameter>start</parameter> <type>integer</type>
3335+
<optional>, <parameter>N</parameter> <type>integer</type>
3336+
<optional>, <parameter>endoption</parameter> <type>integer</type>
3337+
<optional>, <parameter>flags</parameter> <type>text</type>
3338+
<optional>, <parameter>subexpr</parameter> <type>integer</type> </optional> </optional> </optional> </optional> </optional> )
33393339
<returnvalue>integer</returnvalue>
33403340
</para>
33413341
<para>
@@ -3360,7 +3360,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
33603360
<primary>regexp_like</primary>
33613361
</indexterm>
33623362
<function>regexp_like</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>
3363-
[, <parameter>flags</parameter> <type>text</type> ] )
3363+
<optional>, <parameter>flags</parameter> <type>text</type> </optional> )
33643364
<returnvalue>boolean</returnvalue>
33653365
</para>
33663366
<para>
@@ -3380,7 +3380,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
33803380
<indexterm>
33813381
<primary>regexp_match</primary>
33823382
</indexterm>
3383-
<function>regexp_match</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ] )
3383+
<function>regexp_match</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> <optional>, <parameter>flags</parameter> <type>text</type> </optional> )
33843384
<returnvalue>text[]</returnvalue>
33853385
</para>
33863386
<para>
@@ -3400,7 +3400,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
34003400
<indexterm>
34013401
<primary>regexp_matches</primary>
34023402
</indexterm>
3403-
<function>regexp_matches</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ] )
3403+
<function>regexp_matches</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> <optional>, <parameter>flags</parameter> <type>text</type> </optional> )
34043404
<returnvalue>setof text[]</returnvalue>
34053405
</para>
34063406
<para>
@@ -3473,7 +3473,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
34733473
<indexterm>
34743474
<primary>regexp_split_to_array</primary>
34753475
</indexterm>
3476-
<function>regexp_split_to_array</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ] )
3476+
<function>regexp_split_to_array</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> <optional>, <parameter>flags</parameter> <type>text</type> </optional> )
34773477
<returnvalue>text[]</returnvalue>
34783478
</para>
34793479
<para>
@@ -3492,7 +3492,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
34923492
<indexterm>
34933493
<primary>regexp_split_to_table</primary>
34943494
</indexterm>
3495-
<function>regexp_split_to_table</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ] )
3495+
<function>regexp_split_to_table</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> <optional>, <parameter>flags</parameter> <type>text</type> </optional> )
34963496
<returnvalue>setof text</returnvalue>
34973497
</para>
34983498
<para>
@@ -3516,10 +3516,10 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
35163516
<primary>regexp_substr</primary>
35173517
</indexterm>
35183518
<function>regexp_substr</function> ( <parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>
3519-
[, <parameter>start</parameter> <type>integer</type>
3520-
[, <parameter>N</parameter> <type>integer</type>
3521-
[, <parameter>flags</parameter> <type>text</type>
3522-
[, <parameter>subexpr</parameter> <type>integer</type> ] ] ] ] )
3519+
<optional>, <parameter>start</parameter> <type>integer</type>
3520+
<optional>, <parameter>N</parameter> <type>integer</type>
3521+
<optional>, <parameter>flags</parameter> <type>text</type>
3522+
<optional>, <parameter>subexpr</parameter> <type>integer</type> </optional> </optional> </optional> </optional> )
35233523
<returnvalue>text</returnvalue>
35243524
</para>
35253525
<para>
@@ -3986,7 +3986,7 @@ SELECT NOT(ROW(table.*) IS NOT NULL) FROM TABLE; -- detect at least one null in
39863986

39873987
<para>
39883988
<synopsis>
3989-
<function>format</function>(<parameter>formatstr</parameter> <type>text</type> [, <parameter>formatarg</parameter> <type>"any"</type> [, ...] ])
3989+
<function>format</function>(<parameter>formatstr</parameter> <type>text</type> <optional>, <parameter>formatarg</parameter> <type>"any"</type> <optional>, ...</optional> </optional>)
39903990
</synopsis>
39913991
<parameter>formatstr</parameter> is a format string that specifies how the
39923992
result should be formatted. Text in the format string is copied
@@ -10621,7 +10621,7 @@ SELECT date_part('hour', INTERVAL '4 hours 3 minutes');
1062110621

1062210622
<para>
1062310623
<synopsis>
10624-
date_trunc(<replaceable>field</replaceable>, <replaceable>source</replaceable> [, <replaceable>time_zone</replaceable> ])
10624+
date_trunc(<replaceable>field</replaceable>, <replaceable>source</replaceable> <optional>, <replaceable>time_zone</replaceable> </optional>)
1062510625
</synopsis>
1062610626
<replaceable>source</replaceable> is a value expression of type
1062710627
<type>timestamp</type>, <type>timestamp with time zone</type>,
@@ -29708,11 +29708,11 @@ DETAIL: Make sure pg_wal_replay_wait() isn't called within a transaction with a
2970829708
<indexterm>
2970929709
<primary>pg_logical_emit_message</primary>
2971029710
</indexterm>
29711-
<function>pg_logical_emit_message</function> ( <parameter>transactional</parameter> <type>boolean</type>, <parameter>prefix</parameter> <type>text</type>, <parameter>content</parameter> <type>text</type> [, <parameter>flush</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>false</literal>] )
29711+
<function>pg_logical_emit_message</function> ( <parameter>transactional</parameter> <type>boolean</type>, <parameter>prefix</parameter> <type>text</type>, <parameter>content</parameter> <type>text</type> <optional>, <parameter>flush</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>false</literal></optional> )
2971229712
<returnvalue>pg_lsn</returnvalue>
2971329713
</para>
2971429714
<para role="func_signature">
29715-
<function>pg_logical_emit_message</function> ( <parameter>transactional</parameter> <type>boolean</type>, <parameter>prefix</parameter> <type>text</type>, <parameter>content</parameter> <type>bytea</type> [, <parameter>flush</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>false</literal>] )
29715+
<function>pg_logical_emit_message</function> ( <parameter>transactional</parameter> <type>boolean</type>, <parameter>prefix</parameter> <type>text</type>, <parameter>content</parameter> <type>bytea</type> <optional>, <parameter>flush</parameter> <type>boolean</type> <literal>DEFAULT</literal> <literal>false</literal></optional> )
2971629716
<returnvalue>pg_lsn</returnvalue>
2971729717
</para>
2971829718
<para>

0 commit comments

Comments
 (0)