SPI_modifytuple

Name

SPI_modifytuple --  Modifies tuple of relation リレーション中のタプルを変更します。

Synopsis

SPI_modifytuple(rel, tuple , nattrs
, attnum , Values , Nulls)

入力

Relation rel

HeapTuple tuple

Input tuple to be modified

変更対象のタプル。

int nattrs

Number of attribute numbers in attnum

引数 attnum 内の属性番号の数。

int * attnum

Array of numbers of the attributes which are to be changed

変更対象の属性番号の配列。

Datum * Values

New values for the attributes specified

指定属性の変更後の値。

char * Nulls

Which attributes are NULL, if any

どの属性がNULLを取り得るか。

出力

HeapTuple

New tuple with modifications

変更された新しいタプル。

non-NULL if tuple is not NULL and the modify was successful
non-NULL 引数 tuple が NULL で なく、かつ、変更が成功した場合。
NULL only if tuple is NULL 引数 tuple が NULL の 場合のみ。

SPI_result

SPI_ERROR_ARGUMENT if rel is NULL or tuple is NULL or natts ≤ 0 or attnum is NULL or Values is NULL.
SPI_ERROR_ARGUMENT 引数 rel、tuple、attnum、Values のいずれかが NULL 、または、引数 natts ≤ 0 の場合。
SPI_ERROR_NOATTRIBUTE if there is an invalid attribute number in attnum (attnum ≤ 0 or > number of attributes in tuple)
SPI_ERROR_NOATTRIBUTE 引数 arrnum 中に無効な属性番号がある場合( attnum le; 0 または、> タプ ル中の属性数の場合)

説明

SPI_modifytuple Modifies a tuple in upper Executor context. See the section on Memory Management.

SPI_modifytuple は上位エグゼキュータのコンテキ スト内のタプルを変更します。メモリ管理の項を参照して下さい。

使い方

If successful, a pointer to the new tuple is returned. The new tuple is allocated in upper Executor context (see Memory management). Passed tuple is not changed.

成功すると、新しいタプルを示すポインタが返されます。新しいタプルは上位 エグゼキュータのコンテキストに割り当てられています。(メモリ管理の項を 参照して下さい。)元のタプルは変更されません。