Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitb194957

Browse files
committed
doc: Update uses of the word "procedure"
Historically, the term procedure was used as a synonym for function inPostgres/PostgreSQL. Now we have procedures as separate objects fromfunctions, so we need to clean up the documentation to not mix thoseterms.In particular, mentions of "trigger procedures" are changed to "triggerfunctions", and access method "support procedures" are changed to"support functions". (The latter already used FUNCTION in the SQLsyntax anyway.) Also, the terminology in the SPI chapter has beencleaned up.A few tests, examples, and code comments are also adjusted to beconsistent with documentation changes, but not everything.Reported-by: Peter Geoghegan <pg@bowt.ie>Reviewed-by: Jonathan S. Katz <jonathan.katz@excoventures.com>
1 parentaf63926 commitb194957

27 files changed

+175
-182
lines changed

‎doc/src/sgml/brin.sgml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ typedef struct BrinOpcInfo
537537
} BrinOpcInfo;
538538
</programlisting>
539539
<structname>BrinOpcInfo</structname>.<structfield>oi_opaque</structfield> can be used by the
540-
operator class routines to pass information between supportprocedures
540+
operator class routines to pass information between supportfunctions
541541
during an index scan.
542542
</para>
543543
</listitem>
@@ -587,27 +587,27 @@ typedef struct BrinOpcInfo
587587
defined by the user for other data types using equivalent definitions,
588588
without having to write any source code; appropriate catalog entries being
589589
declared is enough. Note that assumptions about the semantics of operator
590-
strategies are embedded in the supportprocedures' source code.
590+
strategies are embedded in the supportfunctions' source code.
591591
</para>
592592

593593
<para>
594594
Operator classes that implement completely different semantics are also
595-
possible, provided implementations of the four main supportprocedures
595+
possible, provided implementations of the four main supportfunctions
596596
described above are written. Note that backwards compatibility across major
597-
releases is not guaranteed: for example, additional supportprocedures might
597+
releases is not guaranteed: for example, additional supportfunctions might
598598
be required in later releases.
599599
</para>
600600

601601
<para>
602602
To write an operator class for a data type that implements a totally
603-
ordered set, it is possible to use the minmax supportprocedures
603+
ordered set, it is possible to use the minmax supportfunctions
604604
alongside the corresponding operators, as shown in
605605
<xref linkend="brin-extensibility-minmax-table"/>.
606-
All operator class members (procedures and operators) are mandatory.
606+
All operator class members (functions and operators) are mandatory.
607607
</para>
608608

609609
<table id="brin-extensibility-minmax-table">
610-
<title>Procedure and Support Numbers for Minmax Operator Classes</title>
610+
<title>Function and Support Numbers for Minmax Operator Classes</title>
611611
<tgroup cols="2">
612612
<thead>
613613
<row>
@@ -617,19 +617,19 @@ typedef struct BrinOpcInfo
617617
</thead>
618618
<tbody>
619619
<row>
620-
<entry>SupportProcedure 1</entry>
620+
<entry>SupportFunction 1</entry>
621621
<entry>internal function <function>brin_minmax_opcinfo()</function></entry>
622622
</row>
623623
<row>
624-
<entry>SupportProcedure 2</entry>
624+
<entry>SupportFunction 2</entry>
625625
<entry>internal function <function>brin_minmax_add_value()</function></entry>
626626
</row>
627627
<row>
628-
<entry>SupportProcedure 3</entry>
628+
<entry>SupportFunction 3</entry>
629629
<entry>internal function <function>brin_minmax_consistent()</function></entry>
630630
</row>
631631
<row>
632-
<entry>SupportProcedure 4</entry>
632+
<entry>SupportFunction 4</entry>
633633
<entry>internal function <function>brin_minmax_union()</function></entry>
634634
</row>
635635
<row>
@@ -659,7 +659,7 @@ typedef struct BrinOpcInfo
659659
<para>
660660
To write an operator class for a complex data type which has values
661661
included within another type, it's possible to use the inclusion support
662-
procedures alongside the corresponding operators, as shown
662+
functions alongside the corresponding operators, as shown
663663
in <xref linkend="brin-extensibility-inclusion-table"/>. It requires
664664
only a single additional function, which can be written in any language.
665665
More functions can be defined for additional functionality. All operators
@@ -668,7 +668,7 @@ typedef struct BrinOpcInfo
668668
</para>
669669

670670
<table id="brin-extensibility-inclusion-table">
671-
<title>Procedure and Support Numbers for Inclusion Operator Classes</title>
671+
<title>Function and Support Numbers for Inclusion Operator Classes</title>
672672
<tgroup cols="3">
673673
<thead>
674674
<row>
@@ -679,42 +679,42 @@ typedef struct BrinOpcInfo
679679
</thead>
680680
<tbody>
681681
<row>
682-
<entry>SupportProcedure 1</entry>
682+
<entry>SupportFunction 1</entry>
683683
<entry>internal function <function>brin_inclusion_opcinfo()</function></entry>
684684
<entry></entry>
685685
</row>
686686
<row>
687-
<entry>SupportProcedure 2</entry>
687+
<entry>SupportFunction 2</entry>
688688
<entry>internal function <function>brin_inclusion_add_value()</function></entry>
689689
<entry></entry>
690690
</row>
691691
<row>
692-
<entry>SupportProcedure 3</entry>
692+
<entry>SupportFunction 3</entry>
693693
<entry>internal function <function>brin_inclusion_consistent()</function></entry>
694694
<entry></entry>
695695
</row>
696696
<row>
697-
<entry>SupportProcedure 4</entry>
697+
<entry>SupportFunction 4</entry>
698698
<entry>internal function <function>brin_inclusion_union()</function></entry>
699699
<entry></entry>
700700
</row>
701701
<row>
702-
<entry>SupportProcedure 11</entry>
702+
<entry>SupportFunction 11</entry>
703703
<entry>function to merge two elements</entry>
704704
<entry></entry>
705705
</row>
706706
<row>
707-
<entry>SupportProcedure 12</entry>
707+
<entry>SupportFunction 12</entry>
708708
<entry>optional function to check whether two elements are mergeable</entry>
709709
<entry></entry>
710710
</row>
711711
<row>
712-
<entry>SupportProcedure 13</entry>
712+
<entry>SupportFunction 13</entry>
713713
<entry>optional function to check if an element is contained within another</entry>
714714
<entry></entry>
715715
</row>
716716
<row>
717-
<entry>SupportProcedure 14</entry>
717+
<entry>SupportFunction 14</entry>
718718
<entry>optional function to check whether an element is empty</entry>
719719
<entry></entry>
720720
</row>
@@ -803,7 +803,7 @@ typedef struct BrinOpcInfo
803803
</table>
804804

805805
<para>
806-
Supportprocedure numbers 1-10 are reserved for the BRIN internal
806+
Supportfunction numbers 1-10 are reserved for the BRIN internal
807807
functions, so the SQL level functions start with number 11. Support
808808
function number 11 is the main function required to build the index.
809809
It should accept two arguments with the same data type as the operator class,
@@ -814,11 +814,11 @@ typedef struct BrinOpcInfo
814814
</para>
815815

816816
<para>
817-
Supportprocedure numbers 12 and 14 are provided to support
818-
irregularities of built-in data types.Procedure number 12
817+
Supportfunction numbers 12 and 14 are provided to support
818+
irregularities of built-in data types.Function number 12
819819
is used to support network addresses from different families which
820-
are not mergeable.Procedure number 14 is used to support
821-
empty ranges.Procedure number 13 is an optional but
820+
are not mergeable.Function number 14 is used to support
821+
empty ranges.Function number 13 is an optional but
822822
recommended one, which allows the new value to be checked before
823823
it is passed to the union function. As the BRIN framework can shortcut
824824
some operations when the union is not changed, using this

‎doc/src/sgml/catalogs.sgml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767

6868
<row>
6969
<entry><link linkend="catalog-pg-amproc"><structname>pg_amproc</structname></link></entry>
70-
<entry>access method supportprocedures</entry>
70+
<entry>access method supportfunctions</entry>
7171
</row>
7272

7373
<row>
@@ -814,8 +814,8 @@
814814

815815
<para>
816816
The catalog <structname>pg_amproc</structname> stores information about
817-
supportprocedures associated with access method operator families. There
818-
is one row for each supportprocedure belonging to an operator family.
817+
supportfunctions associated with access method operator families. There
818+
is one row for each supportfunction belonging to an operator family.
819819
</para>
820820

821821
<table>
@@ -864,14 +864,14 @@
864864
<entry><structfield>amprocnum</structfield></entry>
865865
<entry><type>int2</type></entry>
866866
<entry></entry>
867-
<entry>Supportprocedure number</entry>
867+
<entry>Supportfunction number</entry>
868868
</row>
869869

870870
<row>
871871
<entry><structfield>amproc</structfield></entry>
872872
<entry><type>regproc</type></entry>
873873
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
874-
<entry>OID of theprocedure</entry>
874+
<entry>OID of thefunction</entry>
875875
</row>
876876

877877
</tbody>
@@ -882,9 +882,9 @@
882882
The usual interpretation of the
883883
<structfield>amproclefttype</structfield> and <structfield>amprocrighttype</structfield> fields
884884
is that they identify the left and right input types of the operator(s)
885-
that a particular supportprocedure supports. For some access methods
886-
these match the input data type(s) of the supportprocedure itself, for
887-
others not. There is a notion of <quote>default</quote> supportprocedures for
885+
that a particular supportfunction supports. For some access methods
886+
these match the input data type(s) of the supportfunction itself, for
887+
others not. There is a notion of <quote>default</quote> supportfunctions for
888888
an index, which are those with <structfield>amproclefttype</structfield> and
889889
<structfield>amprocrighttype</structfield> both equal to the index operator class's
890890
<structfield>opcintype</structfield>.
@@ -2471,7 +2471,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
24712471

24722472
<para>
24732473
The catalog <structname>pg_conversion</structname> describes
2474-
encoding conversionprocedures. See <xref linkend="sql-createconversion"/>
2474+
encoding conversionfunctions. See <xref linkend="sql-createconversion"/>
24752475
for more information.
24762476
</para>
24772477

@@ -2537,7 +2537,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
25372537
<entry><structfield>conproc</structfield></entry>
25382538
<entry><type>regproc</type></entry>
25392539
<entry><literal><link linkend="catalog-pg-proc"><structname>pg_proc</structname></link>.oid</literal></entry>
2540-
<entry>Conversionprocedure</entry>
2540+
<entry>Conversionfunction</entry>
25412541
</row>
25422542

25432543
<row>

‎doc/src/sgml/event-trigger.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,9 +1053,9 @@ CREATE EVENT TRIGGER noddl ON ddl_command_start
10531053
<screen>
10541054
=# \dy
10551055
List of event triggers
1056-
Name | Event | Owner | Enabled |Procedure | Tags
1057-
-------+-------------------+-------+---------+-----------+------
1058-
noddl | ddl_command_start | dim | enabled | noddl|
1056+
Name | Event | Owner | Enabled |Function | Tags
1057+
-------+-------------------+-------+---------+----------+------
1058+
noddl | ddl_command_start | dim | enabled | noddl |
10591059
(1 row)
10601060

10611061
=# CREATE TABLE foo(id serial);

‎doc/src/sgml/func.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12360,7 +12360,7 @@ SELECT setval('foo', 42, false); <lineannotation>Next <function>nextval</func
1236012360
<tip>
1236112361
<para>
1236212362
If your needs go beyond the capabilities of these conditional
12363-
expressions, you might want to consider writing astored procedure
12363+
expressions, you might want to consider writing aserver-side function
1236412364
in a more expressive programming language.
1236512365
</para>
1236612366
</tip>

‎doc/src/sgml/plhandler.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ plsample_call_handler(PG_FUNCTION_ARGS)
119119
if (CALLED_AS_TRIGGER(fcinfo))
120120
{
121121
/*
122-
* Called as a triggerprocedure
122+
* Called as a triggerfunction
123123
*/
124124
TriggerData *trigdata = (TriggerData *) fcinfo-&gt;context;
125125

‎doc/src/sgml/plperl.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@ CREATE TRIGGER test_valid_id_trig
13371337
</para>
13381338

13391339
<para>
1340-
The return value of the triggerprocedure is ignored.
1340+
The return value of the triggerfunction is ignored.
13411341
</para>
13421342

13431343
<para>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp