Add SPI_getnspname(), including documentation.
authorNeil Conway <neilc@samurai.com>
Tue, 29 Mar 2005 02:53:53 +0000 (02:53 +0000)
committerNeil Conway <neilc@samurai.com>
Tue, 29 Mar 2005 02:53:53 +0000 (02:53 +0000)
doc/src/sgml/spi.sgml
src/backend/executor/spi.c
src/include/executor/spi.h

index da873542922451fc2f9f4db33454ab28c8b907b5..4d97b9a703223cd66730d27664996dbdfedc157f 100644 (file)
@@ -2153,6 +2153,60 @@ char * SPI_getrelname(Relation <parameter>rel</parameter>)
  </refsect1>
 </refentry>
 
+<refentry id="spi-spi-getnspname">
+ <refmeta>
+  <refentrytitle>SPI_getnspname</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+  <refname>SPI_getnspname</refname>
+  <refpurpose>return the namespace of the specified relation</refpurpose>
+ </refnamediv>
+
+ <indexterm><primary>SPI_getnspname</primary></indexterm>
+
+ <refsynopsisdiv>
+<synopsis>
+char * SPI_getnspname(Relation <parameter>rel</parameter>)
+</synopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+  <title>Description</title>
+
+  <para>
+   <function>SPI_getnspname</function> returns a copy of the name of
+   the namespace that the specified <structname>Relation</structname>
+   belongs to. This is equivalent to the relation's schema. You should
+   <function>pfree</function> the return value of this function when
+   you are finished with it.
+  </para>
+ </refsect1>
+
+ <refsect1>
+  <title>Arguments</title>
+
+  <variablelist>
+   <varlistentry>
+    <term><literal>Relation <parameter>rel</parameter></literal></term>
+    <listitem>
+     <para>
+      input relation
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1>
+  <title>Return Value</title>
+
+  <para>
+   The name of the specified relation's namespace.
+  </para>
+ </refsect1>
+</refentry>
+
  </sect1>
 
  <sect1 id="spi-memory">
index 54f8818d6a7ae94bd804ce386eba5a6041cf98d3..f64d5d8e5a039e2940d855b14c9d9db41d02fef5 100644 (file)
@@ -760,6 +760,12 @@ SPI_getrelname(Relation rel)
        return pstrdup(RelationGetRelationName(rel));
 }
 
+char *
+SPI_getnspname(Relation rel)
+{
+    return get_namespace_name(RelationGetNamespace(rel));
+}
+
 void *
 SPI_palloc(Size size)
 {
index 6c1d651bc20876884ef334d8efbfc0f4e330ae8b..19873e81a3140c8fff757bd86ce4549a15166caa 100644 (file)
@@ -113,6 +113,7 @@ extern Datum SPI_getbinval(HeapTuple tuple, TupleDesc tupdesc, int fnumber, bool
 extern char *SPI_gettype(TupleDesc tupdesc, int fnumber);
 extern Oid     SPI_gettypeid(TupleDesc tupdesc, int fnumber);
 extern char *SPI_getrelname(Relation rel);
+extern char *SPI_getnspname(Relation rel);
 extern void *SPI_palloc(Size size);
 extern void *SPI_repalloc(void *pointer, Size size);
 extern void SPI_pfree(void *pointer);