Re: [PATCHES] Some new SPI functions

2004-02-15 Thread Thomas Hallgren
 Who did you think would do it?

 regards, tom lane

you :-)

Seriously, I didn't give it much though. This is undoubtedly the best way
although some projects handle it differently. A  tech-writer perhaps, with
better writing skills then programmers in general. But people like that are
probabaly not too common in the open source field. If you don't do like
JBoss and charge for the docs (I'm *not* in favor of that).

Anyway, here's the patch again. This time with documentation.

Index: doc/src/sgml/spi.sgml
===
retrieving revision 1.30
diff -u -r1.30 spi.sgml
--- doc/src/sgml/spi.sgml 1 Dec 2003 22:07:57 - 1.30
+++ doc/src/sgml/spi.sgml 15 Feb 2004 13:47:13 -
@@ -573,6 +573,190 @@

 !-- *** --

+refentry id=spi-spi-getargcount
+ refmeta
+  refentrytitleSPI_getargcount/refentrytitle
+ /refmeta
+
+ refnamediv
+  refnameSPI_getargcount/refname
+  refpurposereturns the number of arguments needed when executing a plan
+  prepared by functionSPI_prepare/function/refpurpose
+ /refnamediv
+
+ indextermprimarySPI_getargcount/primary/indexterm
+
+ refsynopsisdiv
+synopsis
+int SPI_getargcount(void * parameterplan/parameter)
+/synopsis
+ /refsynopsisdiv
+
+ refsect1
+  titleDescription/title
+
+  para
+   functionSPI_getargcount/function returns the number of arguments
needed
+   when executing a plan prepared by functionSPI_prepare/function.
+  /para
+ /refsect1
+
+ refsect1
+  titleArguments/title
+
+  variablelist
+   varlistentry
+termliteralvoid * parameterplan/parameter/literal/term
+listitem
+ para
+  execution plan (returned by functionSPI_prepare/function)
+ /para
+/listitem
+   /varlistentry
+  /variablelist
+ /refsect1
+
+ refsect1
+  titleReturn Value/title
+  para
+The expected argument count for the parameterplan/parameter or
+symbolSPI_ERROR_ARGUMENT/symbol if the parameterplan
+/parameter is symbolNULL/symbol
+  /para
+ /refsect1
+/refentry
+
+!-- *** --
+
+refentry id=spi-spi-getargtypeid
+ refmeta
+  refentrytitleSPI_getargtypeid/refentrytitle
+ /refmeta
+
+ refnamediv
+  refnameSPI_getargtypeid/refname
+  refpurposereturns the expected typeid for the specified argument when
+  executing a plan prepared by
functionSPI_prepare/function/refpurpose
+ /refnamediv
+
+ indextermprimarySPI_getargtypeid/primary/indexterm
+
+ refsynopsisdiv
+synopsis
+Oid SPI_getargtypeid(void * parameterplan/parameter, int
parameterargIndex/parameter)
+/synopsis
+ /refsynopsisdiv
+
+ refsect1
+  titleDescription/title
+
+  para
+   functionSPI_getargtypeid/function returns the Oid representing the
type
+   id for argument at parameterargIndex/parameter in a plan prepared by
+   functionSPI_prepare/function. First argument is at index zero.
+  /para
+ /refsect1
+
+ refsect1
+  titleArguments/title
+
+  variablelist
+   varlistentry
+termliteralvoid * parameterplan/parameter/literal/term
+listitem
+ para
+  execution plan (returned by functionSPI_prepare/function)
+ /para
+/listitem
+   /varlistentry
+
+   varlistentry
+termliteralint parameterargIndex/parameter/literal/term
+listitem
+ para
+  zero based index of the argument
+ /para
+/listitem
+   /varlistentry
+  /variablelist
+ /refsect1
+
+ refsect1
+  titleReturn Value/title
+  para
+The type id of the argument at the given index or symbol
+SPI_ERROR_ARGUMENT/symbol if the parameterplan/parameter is
+symbolNULL/symbol or parameterargIndex/parameter is less than 0
or
+not less than the number of arguments declared for the parameterplan
+/parameter
+  /para
+ /refsect1
+/refentry
+
+!-- *** --
+
+refentry id=spi-spi-is_cursor_plan
+ refmeta
+  refentrytitleSPI_is_cursor_plan/refentrytitle
+ /refmeta
+
+ refnamediv
+  refnameSPI_is_cursor_plan/refname
+  refpurposereturns symboltrue/symbol if a plan
+  prepared by functionSPI_prepare/function can be passed
+  as an argument to functionSPI_cursor_open/function/refpurpose
+ /refnamediv
+
+ indextermprimarySPI_is_cursor_plan/primary/indexterm
+
+ refsynopsisdiv
+synopsis
+bool SPI_is_cursor_plan(void * parameterplan/parameter)
+/synopsis
+ /refsynopsisdiv
+
+ refsect1
+  titleDescription/title
+
+  para
+   functionSPI_is_cursor_plan/function returns symboltrue/symbol
+   if a plan prepared by functionSPI_prepare/function can be passed
+   as an argument to functionSPI_cursor_open/function and symbol
+   false/symbol if that is not the case. The criteria is that the
+   parameterplan/parameter represents one single command and that this
+   command is a commandSELECT/command without an
commandINTO/command
+   clause.
+  /para
+ /refsect1
+
+ refsect1
+  titleArguments/title
+
+  variablelist
+   varlistentry
+termliteralvoid * parameterplan/parameter/literal/term
+listitem
+ para
+  execution plan (returned 

Re: [PATCHES] Some new SPI functions

2004-02-14 Thread Thomas Hallgren
Sure, I'll provide some docs. Just wasn't aware that patchers did that.

- thomas

- Original Message - 
From: Bruce Momjian [EMAIL PROTECTED]
To: Thomas Hallgren [EMAIL PROTECTED]
Cc: [EMAIL PROTECTED]
Sent: Friday, February 13, 2004 06:12
Subject: Re: [PATCHES] Some new SPI functions



 Thomas, if this is ready for application, would you make some SGML
 changes to match, or give me text to add for them.  Thanks.

 --
-

 Thomas Hallgren wrote:
  I need three new functions in the Server Programming Interface (SPI)
when
  mapping an ExecutionPlan to a Java prepared statement (Pl/Java project).
 
 
  The execute method of the prepared statement needs to know if the result
is
  a ResultSet (SPI_cursor_open) or just a number indicated how many rows
that
  where affected (SPI_execp). Currently there's no way I can tell by just
  looking at the plan unless I violate the data hiding and use spi_priv.h.
I
  really don't want to do that. Hence the need for SPI_is_cursor_plan
 
  I send an array of java objects for the arguments. The
  SPI_cursor_open/SPI_execp of course expects the arguments to be Datum's
and
  the mapper must convert java objects. The mapping code is based on Oid's
so
  I need a way to extract the number of expected arguments and the typeid
of
  each arguments.
 
  I find it likely that other pllang implementations where similar
support
  is planned might find these functions useful.
 
 
  Thomas Hallgren
 
  Index: src/backend/executor/spi.c
  ===
  retrieving revision 1.109
  diff -u -r1.109 spi.c
  --- src/backend/executor/spi.c 2 Dec 2003 19:26:47 - 1.109
  +++ src/backend/executor/spi.c 12 Feb 2004 11:13:11 -
  @@ -918,6 +918,65 @@
PortalDrop(portal, false);
   }
 
  +/*
  + * Returns the Oid representing the type id for argument at argIndex.
First
  + * parameter is at index zero.
  + */
  +Oid
  +SPI_getargtypeid(void *plan, int argIndex)
  +{
  + if (plan == NULL || argIndex  0 || argIndex =
((_SPI_plan*)plan)-nargs)
  + {
  +  SPI_result = SPI_ERROR_ARGUMENT;
  +  return InvalidOid;
  + }
  + return ((_SPI_plan *) plan)-argtypes[argIndex];
  +}
  +
  +/*
  + * Returns the number of arguments for the prepared plan.
  + */
  +int
  +SPI_getargcount(void *plan)
  +{
  + if (plan == NULL)
  + {
  +  SPI_result = SPI_ERROR_ARGUMENT;
  +  return -1;
  + }
  + return ((_SPI_plan *) plan)-nargs;
  +}
  +
  +/*
  + * Returns true if the plan contains exactly one command
  + * and that command originates from normal SELECT (i.e.
  + * *not* a SELECT ... INTO). In essence, the result indicates
  + * if the command can be used with SPI_cursor_open
  + *
  + * Parameters
  + *plan A plan previously prepared using SPI_prepare
  + */
  +bool
  +SPI_is_cursor_plan(void *plan)
  +{
  + List *qtlist;
  + _SPI_plan *spiplan = (_SPI_plan *) plan;
  + if (spiplan == NULL)
  + {
  +  SPI_result = SPI_ERROR_ARGUMENT;
  +  return false;
  + }
  +
  + qtlist = spiplan-qtlist;
  + if(length(spiplan-ptlist) == 1  length(qtlist) == 1)
  + {
  +  Query *queryTree = (Query *) lfirst((List *) lfirst(qtlist));
  +  if(queryTree-commandType == CMD_SELECT  queryTree-into == NULL)
  +   return true;
  + }
  + return false;
  +}
  +
   /* === private functions === */
 
   /*
  Index: src/include/executor/spi.h
  ===
  retrieving revision 1.41
  diff -u -r1.41 spi.h
  --- src/include/executor/spi.h 2 Dec 2003 19:26:47 - 1.41
  +++ src/include/executor/spi.h 12 Feb 2004 11:13:21 -
  @@ -90,6 +90,10 @@
   extern void *SPI_saveplan(void *plan);
   extern int SPI_freeplan(void *plan);
 
  +extern Oid SPI_getargtypeid(void *plan, int argIndex);
  +extern int SPI_getargcount(void *plan);
  +extern bool SPI_is_cursor_plan(void *plan);
  +
   extern HeapTuple SPI_copytuple(HeapTuple tuple);
   extern TupleDesc SPI_copytupledesc(TupleDesc tupdesc);
   extern TupleTableSlot *SPI_copytupleintoslot(HeapTuple tuple,
 
 
 
  ---(end of broadcast)---
  TIP 8: explain analyze is your friend
 

 -- 
   Bruce Momjian|  http://candle.pha.pa.us
   [EMAIL PROTECTED]   |  (610) 359-1001
   +  If your life is a hard drive, |  13 Roberts Road
   +  Christ can be your backup.|  Newtown Square, Pennsylvania
19073



---(end of broadcast)---
TIP 7: don't forget to increase your free space map settings


Re: [PATCHES] Some new SPI functions

2004-02-14 Thread Christopher Kings-Lynne


Thomas Hallgren wrote:

Sure, I'll provide some docs. Just wasn't aware that patchers did that.

- thomas
Yeah, in PostgreSQL, whoever writes the patch also must submit docs. 
It's the best way of keeping docs up to date :)

Chris

---(end of broadcast)---
TIP 1: subscribe and unsubscribe commands go to [EMAIL PROTECTED]


Re: [PATCHES] Some new SPI functions

2004-02-14 Thread Tom Lane
Thomas Hallgren [EMAIL PROTECTED] writes:
 Sure, I'll provide some docs. Just wasn't aware that patchers did that.

Who did you think would do it?

regards, tom lane

---(end of broadcast)---
TIP 3: if posting/reading through Usenet, please send an appropriate
  subscribe-nomail command to [EMAIL PROTECTED] so that your
  message can get through to the mailing list cleanly


Re: [PATCHES] Some new SPI functions

2004-02-12 Thread Tom Lane
Thomas Hallgren [EMAIL PROTECTED] writes:
 I need three new functions in the Server Programming Interface (SPI) when
 mapping an ExecutionPlan to a Java prepared statement (Pl/Java project).

These functions look reasonable, but where is the documentation patch?

regards, tom lane

---(end of broadcast)---
TIP 6: Have you searched our list archives?

   http://archives.postgresql.org


Re: [PATCHES] Some new SPI functions

2004-02-12 Thread Bruce Momjian
Tom Lane wrote:
 Thomas Hallgren [EMAIL PROTECTED] writes:
  I need three new functions in the Server Programming Interface (SPI) when
  mapping an ExecutionPlan to a Java prepared statement (Pl/Java project).
 
 These functions look reasonable, but where is the documentation patch?

I assume it will come when the final patch is submitted.

-- 
  Bruce Momjian|  http://candle.pha.pa.us
  [EMAIL PROTECTED]   |  (610) 359-1001
  +  If your life is a hard drive, |  13 Roberts Road
  +  Christ can be your backup.|  Newtown Square, Pennsylvania 19073

---(end of broadcast)---
TIP 8: explain analyze is your friend


Re: [PATCHES] Some new SPI functions

2004-02-12 Thread Bruce Momjian

Thomas, if this is ready for application, would you make some SGML
changes to match, or give me text to add for them.  Thanks.

---

Thomas Hallgren wrote:
 I need three new functions in the Server Programming Interface (SPI) when
 mapping an ExecutionPlan to a Java prepared statement (Pl/Java project).
 
 
 The execute method of the prepared statement needs to know if the result is
 a ResultSet (SPI_cursor_open) or just a number indicated how many rows that
 where affected (SPI_execp). Currently there's no way I can tell by just
 looking at the plan unless I violate the data hiding and use spi_priv.h. I
 really don't want to do that. Hence the need for SPI_is_cursor_plan
 
 I send an array of java objects for the arguments. The
 SPI_cursor_open/SPI_execp of course expects the arguments to be Datum's and
 the mapper must convert java objects. The mapping code is based on Oid's so
 I need a way to extract the number of expected arguments and the typeid of
 each arguments.
 
 I find it likely that other pllang implementations where similar support
 is planned might find these functions useful.
 
 
 Thomas Hallgren
 
 Index: src/backend/executor/spi.c
 ===
 retrieving revision 1.109
 diff -u -r1.109 spi.c
 --- src/backend/executor/spi.c 2 Dec 2003 19:26:47 - 1.109
 +++ src/backend/executor/spi.c 12 Feb 2004 11:13:11 -
 @@ -918,6 +918,65 @@
   PortalDrop(portal, false);
  }
 
 +/*
 + * Returns the Oid representing the type id for argument at argIndex. First
 + * parameter is at index zero.
 + */
 +Oid
 +SPI_getargtypeid(void *plan, int argIndex)
 +{
 + if (plan == NULL || argIndex  0 || argIndex = ((_SPI_plan*)plan)-nargs)
 + {
 +  SPI_result = SPI_ERROR_ARGUMENT;
 +  return InvalidOid;
 + }
 + return ((_SPI_plan *) plan)-argtypes[argIndex];
 +}
 +
 +/*
 + * Returns the number of arguments for the prepared plan.
 + */
 +int
 +SPI_getargcount(void *plan)
 +{
 + if (plan == NULL)
 + {
 +  SPI_result = SPI_ERROR_ARGUMENT;
 +  return -1;
 + }
 + return ((_SPI_plan *) plan)-nargs;
 +}
 +
 +/*
 + * Returns true if the plan contains exactly one command
 + * and that command originates from normal SELECT (i.e.
 + * *not* a SELECT ... INTO). In essence, the result indicates
 + * if the command can be used with SPI_cursor_open
 + *
 + * Parameters
 + *plan A plan previously prepared using SPI_prepare
 + */
 +bool
 +SPI_is_cursor_plan(void *plan)
 +{
 + List *qtlist;
 + _SPI_plan *spiplan = (_SPI_plan *) plan;
 + if (spiplan == NULL)
 + {
 +  SPI_result = SPI_ERROR_ARGUMENT;
 +  return false;
 + }
 +
 + qtlist = spiplan-qtlist;
 + if(length(spiplan-ptlist) == 1  length(qtlist) == 1)
 + {
 +  Query *queryTree = (Query *) lfirst((List *) lfirst(qtlist));
 +  if(queryTree-commandType == CMD_SELECT  queryTree-into == NULL)
 +   return true;
 + }
 + return false;
 +}
 +
  /* === private functions === */
 
  /*
 Index: src/include/executor/spi.h
 ===
 retrieving revision 1.41
 diff -u -r1.41 spi.h
 --- src/include/executor/spi.h 2 Dec 2003 19:26:47 - 1.41
 +++ src/include/executor/spi.h 12 Feb 2004 11:13:21 -
 @@ -90,6 +90,10 @@
  extern void *SPI_saveplan(void *plan);
  extern int SPI_freeplan(void *plan);
 
 +extern Oid SPI_getargtypeid(void *plan, int argIndex);
 +extern int SPI_getargcount(void *plan);
 +extern bool SPI_is_cursor_plan(void *plan);
 +
  extern HeapTuple SPI_copytuple(HeapTuple tuple);
  extern TupleDesc SPI_copytupledesc(TupleDesc tupdesc);
  extern TupleTableSlot *SPI_copytupleintoslot(HeapTuple tuple,
 
 
 
 ---(end of broadcast)---
 TIP 8: explain analyze is your friend
 

-- 
  Bruce Momjian|  http://candle.pha.pa.us
  [EMAIL PROTECTED]   |  (610) 359-1001
  +  If your life is a hard drive, |  13 Roberts Road
  +  Christ can be your backup.|  Newtown Square, Pennsylvania 19073

---(end of broadcast)---
TIP 7: don't forget to increase your free space map settings