SPI_returntuple

PostgreSQL 17.0文書
		45.3. メモリ管理	誤訳等の報告
前へ	上へ	SPI_returntuple	次へ

SPI_returntuple <refpurpose>prepare to return a tuple as a Datum</refpurpose> — Datumとしてタプルを返す準備をする

概要

HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

説明

<title>Description</title>

<function>SPI_returntuple</function> makes a copy of a row in the upper executor context, returning it in the form of a row type <type>Datum</type>. The returned pointer need only be converted to <type>Datum</type> via <function>PointerGetDatum</function> before returning. SPI_returntupleは上位エグゼキュータコンテキスト内に行の複製を作成し、それを行型のDatum形式で返します。返されるポインタは、返す前にPointerGetDatumを使用してDatumに変換することのみが必要です。

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_resultをSPI_ERROR_UNCONNECTEDにセットします。

Note that this should be used for functions that are declared to return composite types. It is not used for triggers; use <function>SPI_copytuple</function> for returning a modified row in a trigger. この関数は複合型を返すものと宣言された関数に対して使用しなければなりません。トリガでは使用されません。トリガで変更された行を返すにはSPI_copytupleを使用してください。

引数

<title>Arguments</title>

HeapTuple row: row to be copied コピーされる行
TupleDesc rowdesc: descriptor for row (pass the same descriptor each time for most effective caching) 行の記述子（最も効率的にキャッシュを行えるように毎回同一の記述子を渡してください）

戻り値

<title>Return Value</title>

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

前へ	上へ	次へ
SPI_copytuple	ホーム	SPI_modifytuple