begriffs open source - ai-pg/blob - full-docs/man3/SPI_unregister_relation.3

   1 '\" t
   2 .\"     Title: SPI_unregister_relation
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SPI_UNREGISTER_RELATION" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 SPI_unregister_relation \- remove an ephemeral named relation from the registry
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 int SPI_unregister_relation(const char * \fIname\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_unregister_relation\fR
  40 removes an ephemeral named relation from the registry for the current connection\&.
  41 .SH "ARGUMENTS"
  42 .PP
  43 const char * \fIname\fR
  44 .RS 4
  45 the relation registry entry name
  46 .RE
  47 .SH "RETURN VALUE"
  48 .PP
  49 If the execution of the command was successful then the following (nonnegative) value will be returned:
  50 .PP
  51 SPI_OK_REL_UNREGISTER
  52 .RS 4
  53 if the tuplestore has been successfully removed from the registry
  54 .RE
  55 .PP
  56 On error, one of the following negative values is returned:
  57 .PP
  58 SPI_ERROR_ARGUMENT
  59 .RS 4
  60 if
  61 \fIname\fR
  62 is
  63 NULL
  64 .RE
  65 .PP
  66 SPI_ERROR_UNCONNECTED
  67 .RS 4
  68 if called from an unconnected C function
  69 .RE
  70 .PP
  71 SPI_ERROR_REL_NOT_FOUND
  72 .RS 4
  73 if
  74 \fIname\fR
  75 is not found in the registry for the current connection
  76 .RE