Re: SPI not defined.

2018-01-29 Thread David G. Johnston
On Monday, January 29, 2018, PG Doc comments form 
wrote:

> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/9.5/static/contrib-spi.html
> Description:
>
> In the appendix for Additional Supplied Modules there is a module spi.  If
> you click through the page for that module it never defines what spi is.
> If
> you search for PostgreSQL spi you get the page that doesn't define it and
> some other information on the PostgreSQL Server Programming Interface,
> which
> I think is a different SPI.


>
No, SPI in that module is indeed "Server Programming Interface".


>
>   I would recommend that the module page define
>
the spi acronym.


Seems reasonable.

David J.


Re: SPI not defined.

2018-01-29 Thread Bruce Momjian
On Mon, Jan 29, 2018 at 03:07:06PM -0700, David G. Johnston wrote:
> On Monday, January 29, 2018, PG Doc comments form 
> No, SPI in that module is indeed "Server Programming Interface".
> 
>   I would recommend that the module page define
> 
> the spi acronym.
> 
> Seems reasonable.

How is the attached patch?

-- 
  Bruce Momjian  http://momjian.us
  EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+  Ancient Roman grave inscription +
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..2dc2d92
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***
*** 10,16 
  
   
The spi module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described
--- 10,17 
  
   
The spi module provides several workable examples
!   of using the Server Programming Interface (SPI) and
!   triggers.  While these functions are of some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described


Re: SPI not defined.

2018-01-29 Thread David G. Johnston
On Monday, January 29, 2018, Bruce Momjian  wrote:

>
> How is the attached patch?
>
>
Maybe add a link to:

 https://www.postgresql.org/docs/10/static/spi.html

Also, on that page, the error handling mechanisms have been "in flux" since
8.0 ... ?

" This is not currently documented because the mechanisms required are
still in flux. "

David J.


Re: SPI not defined.

2018-01-29 Thread Tom Lane
Bruce Momjian  writes:
> How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

regards, tom lane



Re: SPI not defined.

2018-01-29 Thread Bruce Momjian
On Mon, Jan 29, 2018 at 08:39:22PM -0700, David G. Johnston wrote:
> On Monday, January 29, 2018, Bruce Momjian  wrote:
> 
> 
> How is the attached patch?
> 
> 
> 
> Maybe add a link to:
> 
>  https://www.postgresql.org/docs/10/static/spi.html
> 
> Also, on that page, the error handling mechanisms have been "in flux" since 
> 8.0
> ... ?
> 
> " This is not currently documented because the mechanisms required are still 
> in
> flux. "

OK, updated patch with both fixes.

-- 
  Bruce Momjian  http://momjian.us
  EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+  Ancient Roman grave inscription +
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..2dc2d92
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***
*** 10,16 
  
   
The spi module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described
--- 10,17 
  
   
The spi module provides several workable examples
!   of using the Server Programming Interface (SPI) and
!   triggers.  While these functions are of some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described


Re: SPI not defined.

2018-01-29 Thread Bruce Momjian
On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> Bruce Momjian  writes:
> > How is the attached patch?
> 
> Maybe also make that text into a hyperlink to the SPI manual chapter?

Yes, that's what I just did in the new patch.

-- 
  Bruce Momjian  http://momjian.us
  EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+  Ancient Roman grave inscription +



Re: SPI not defined.

2018-01-29 Thread Tom Lane
Bruce Momjian  writes:
> OK, updated patch with both fixes.

AFAICS that's the same patch you posted before.

regards, tom lane



Re: SPI not defined.

2018-01-29 Thread David G. Johnston
On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian  wrote:

> On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> > Bruce Momjian  writes:
> > > How is the attached patch?
> >
> > Maybe also make that text into a hyperlink to the SPI manual chapter?
>
> Yes, that's what I just did in the new patch.


​Your second attachment is the same as the first.

Dave​


Re: SPI not defined.

2018-01-29 Thread Bruce Momjian
On Mon, Jan 29, 2018 at 08:58:10PM -0700, David G. Johnston wrote:
> On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian  wrote:
> 
> On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> > Bruce Momjian  writes:
> > > How is the attached patch?
> >
> > Maybe also make that text into a hyperlink to the SPI manual chapter?
> 
> Yes, that's what I just did in the new patch.
> 
> 
> ​Your second attachment is the same as the first.

Oops, here is the right one.

-- 
  Bruce Momjian  http://momjian.us
  EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+  Ancient Roman grave inscription +
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..844ea16
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***
*** 10,16 
  
   
The spi module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described
--- 10,18 
  
   
The spi module provides several workable examples
!   of using the Server Programming Interface
!   (SPI) and triggers.  While these functions are of
!   some value in
their own right, they are even more useful as examples to modify for
your own purposes.  The functions are general enough to be used
with any table, but you have to specify table and field names (as described
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
new file mode 100644
index 1044892..0bac342
*** a/doc/src/sgml/spi.sgml
--- b/doc/src/sgml/spi.sgml
***
*** 42,49 
have documented error-return conventions.  Those conventions only apply
for errors detected within the SPI functions themselves, however.)
It is possible to recover control after an error by establishing your own
!   subtransaction surrounding SPI calls that might fail.  This is not currently
!   documented because the mechanisms required are still in flux.
   
  
   
--- 42,48 
have documented error-return conventions.  Those conventions only apply
for errors detected within the SPI functions themselves, however.)
It is possible to recover control after an error by establishing your own
!   subtransaction surrounding SPI calls that might fail.
   
  
   


Re: SPI not defined.

2018-01-31 Thread Bruce Momjian
On Mon, Jan 29, 2018 at 11:03:32PM -0500, Bruce Momjian wrote:
> On Mon, Jan 29, 2018 at 08:58:10PM -0700, David G. Johnston wrote:
> > On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian  wrote:
> > 
> > On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> > > Bruce Momjian  writes:
> > > > How is the attached patch?
> > >
> > > Maybe also make that text into a hyperlink to the SPI manual chapter?
> > 
> > Yes, that's what I just did in the new patch.
> > 
> > 
> > ​Your second attachment is the same as the first.
> 
> Oops, here is the right one.

Done and backpatched through 9.3.  Thanks for the feedback.

-- 
  Bruce Momjian  http://momjian.us
  EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+  Ancient Roman grave inscription +