バージョンごとのドキュメント一覧

SPI_copytuple

SPI_copytuple <refpurpose>make a copy of a row in the upper executor context</refpurpose> — 上位エグゼキュータ内に行のコピーを作成する

概要

HeapTuple SPI_copytuple(HeapTuple row)

説明

<title>Description</title>

<function>SPI_copytuple</function> makes a copy of a row in the upper executor context. This is normally used to return a modified row from a trigger. In a function declared to return a composite type, use <function>SPI_returntuple</function> instead. SPI_copytupleは上位エグゼキュータコンテキスト内に行のコピーを作成します。 これは通常、トリガから変更した行を返す時に使用されます。 複合型を返すものと宣言された関数では、代わりにSPI_returntupleを使用してください。

This function can only be used while connected to SPI. Otherwise, it returns NULL and sets <varname>SPI_result</varname> to <symbol>SPI_ERROR_UNCONNECTED</symbol>. この関数はSPIに接続されている間にのみ使うことができます。 それ以外の場合はNULLを返し、SPI_resultSPI_ERROR_UNCONNECTEDにセットします。

引数

<title>Arguments</title>
HeapTuple row

row to be copied コピーされる行

戻り値

<title>Return Value</title>

the copied row, or <symbol>NULL</symbol> on error (see <varname>SPI_result</varname> for an error indication) コピーされた行、あるいはエラー時はNULL (エラーの表示についてはSPI_resultを参照してください)