GridDB C APIリファレンス

Macro Definition Documentation

#define GS_RESULT_OK 0

GridDBに対する命令の実行に成功したことを示す、実行結果コードの値です。

See Also: GSResult

#define GS_SUCCEEDED ( result ) ((result) == GS_RESULT_OK)

実行結果コードに基づきGridDBに対する命令の実行に成功したかどうかのブール値を求めるマクロです。

See Also: GS_RESULT_OK; GSResult

Typedef Documentation

typedef char GSBool

GridDB APIで使用されるブール型です。

: GridDB上のBOOL型と対応します。

typedef char GSChar

GridDB APIで使用される標準の文字の型です。

: この型の文字列エンコーディングは常にUTF-8です。

typedef GSEnum GSType

See Also: GSTypeTag

typedef union GSValueTag GSValue

ロウフィールドに格納できるいずれかの型の値です。

Since: 1.5

Enumeration Type Documentation

enum GSTypeTag

GridDB上のフィールド値の型を表します。

Enumerator
GS_TYPE_STRING	STRING型です。
GS_TYPE_BOOL	BOOL型です。
GS_TYPE_BYTE	BYTE型です。
GS_TYPE_SHORT	SHORT型です。
GS_TYPE_INTEGER	INTEGER型です。
GS_TYPE_LONG	LONG型です。
GS_TYPE_FLOAT	FLOAT型です。
GS_TYPE_DOUBLE	DOUBLE型です。
GS_TYPE_TIMESTAMP	TIMESTAMP型です。カラム定義に用いる場合、精度の指定にはGSTypeOptionの日時精度に関するオプションを用います。ロウオブジェクトのフィールド値の型を識別するために用いる場合は、通常精度のTIMESTAMP値であることを示します。
GS_TYPE_GEOMETRY	GEOMETRY型です。
GS_TYPE_BLOB	BLOB型です。
GS_TYPE_STRING_ARRAY	STRING型配列です。
GS_TYPE_BOOL_ARRAY	BOOL型配列です。
GS_TYPE_BYTE_ARRAY	BYTE型配列です。
GS_TYPE_SHORT_ARRAY	SHORT型配列です。
GS_TYPE_INTEGER_ARRAY	INTEGER型配列です。
GS_TYPE_LONG_ARRAY	LONG型配列です。
GS_TYPE_FLOAT_ARRAY	FLOAT型配列です。
GS_TYPE_DOUBLE_ARRAY	DOUBLE型配列です。
GS_TYPE_TIMESTAMP_ARRAY	TIMESTAMP型配列です。
GS_TYPE_NULL	ロウフィールドにNULLが設定されていることを示します。カラムの型として用いることはできません。 Since 3.5
GS_TYPE_PRECISE_TIMESTAMP	高精度のTIMESTAMP値であることを示します。カラムの型として用いることはできません。ロウオブジェクトのフィールド値の型を識別するために用います。 Since 5.3

Classes バインディング
struct	GSBindingTag
	ロウオブジェクトとロウデータとの対応関係を表すバインディング情報です。More...

Macros バインディング
#define	GS_GET_STRUCT_BINDING(type) GS_STRUCT_BINDING_GETTER_NAME(type) ()
	ユーザ定義構造体とコンテナスキーマとの対応関係の定義を取得します。More...

#define	GS_STRUCT_BINDING(type, entries)
	ユーザ定義構造体とコンテナスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_NAMED_ELEMENT(name, member, memberType)
	カラム名を指定して、ユーザ定義構造体メンバと基本型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_NAMED_KEY(name, member, memberType)
	カラム名を指定して、ユーザ定義構造体メンバとロウキー付き基本型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_NAMED_ARRAY(name, member, sizeMember, elementType)
	カラム名を指定して、ユーザ定義構造体メンバと配列型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_ELEMENT(member, memberType)
	ユーザ定義構造体メンバと基本型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_KEY(member, memberType)
	ユーザ定義構造体メンバとロウキー付き基本型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_ARRAY(member, sizeMember, elementType)
	ユーザ定義構造体メンバと配列型カラムスキーマとの対応関係を定義します。More...

#define	GS_STRUCT_BINDING_COMPOSITE_KEY(member, bindingType)
	ユーザ定義構造体メンバと複合ロウキー付きカラムスキーマとの対応関係を定義します。More...

Typedefs バインディング
typedef struct GSBindingTag	GSBinding
	ロウオブジェクトとロウデータとの対応関係を表すバインディング情報です。

Detailed Description

バインディング

Macro Definition Documentation

バインディング

#define GS_GET_STRUCT_BINDING ( type ) GS_STRUCT_BINDING_GETTER_NAME(type) ()

ユーザ定義構造体とコンテナスキーマとの対応関係の定義を取得します。

: 指定の定義名のGS_STRUCT_BINDINGの定義を参照できるようにする必要があります。

Parameters

type 対応関係の定義名。

Returns: 対応関係を示すGSBinding*型の値

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING	(	type,
		entries
	)

ユーザ定義構造体とコンテナスキーマとの対応関係を定義します。

: 現バージョンでは、静的関数の定義に展開されます。

: 複合ロウキーの構成情報の定義にも使用できます。

Parameters

type	対応関係の定義名。関数名の一部として使用されます。
entries	構造体メンバとカラム定義との対応関係を示す以下の定義の列を、「,」で区切らず順に並べます。 GS_STRUCT_BINDING_NAMED_ELEMENT GS_STRUCT_BINDING_NAMED_KEY GS_STRUCT_BINDING_NAMED_ARRAY GS_STRUCT_BINDING_ELEMENT GS_STRUCT_BINDING_KEY GS_STRUCT_BINDING_ARRAY

See Also: GS_GET_STRUCT_BINDING

#define GS_STRUCT_BINDING_ARRAY	(	member,
		sizeMember,
		elementType
	)

ユーザ定義構造体メンバと配列型カラムスキーマとの対応関係を定義します。

: 構造体メンバの名前がそのままカラム名として使用されます。

Parameters

member	配列ポインタ変数に対応する構造体メンバの名前
sizeMember	配列サイズ変数に対応する構造体メンバの名前
elementType	配列型の要素型の名前

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING_COMPOSITE_KEY	(	member,
		bindingType
	)

ユーザ定義構造体メンバと複合ロウキー付きカラムスキーマとの対応関係を定義します。

Parameters

member	構造体メンバの名前
bindingType	複合ロウキーを構成するユーザ定義構造体の名前。対応する複合ロウキーの構成については、別途GS_STRUCT_BINDINGを通じて定義されていなければならない

See Also: GS_STRUCT_BINDING

Since: 4.3

#define GS_STRUCT_BINDING_ELEMENT	(	member,
		memberType
	)

ユーザ定義構造体メンバと基本型カラムスキーマとの対応関係を定義します。

: 構造体メンバの名前がそのままカラム名として使用されます。

Parameters

member	構造体メンバの名前
memberType	基本型の名前

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING_KEY	(	member,
		memberType
	)

ユーザ定義構造体メンバとロウキー付き基本型カラムスキーマとの対応関係を定義します。

: 構造体メンバの名前がそのままカラム名として使用されます。

Parameters

member	構造体メンバの名前
memberType	基本型の名前

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING_NAMED_ARRAY	(	name,
		member,
		sizeMember,
		elementType
	)

カラム名を指定して、ユーザ定義構造体メンバと配列型カラムスキーマとの対応関係を定義します。

Parameters

name	カラム名
member	配列ポインタ変数に対応する構造体メンバの名前
sizeMember	配列サイズ変数に対応する構造体メンバの名前
elementType	配列型の要素型の名前

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING_NAMED_ELEMENT	(	name,
		member,
		memberType
	)

カラム名を指定して、ユーザ定義構造体メンバと基本型カラムスキーマとの対応関係を定義します。

Parameters

name	カラム名
member	構造体メンバの名前
memberType	基本型の名前

See Also: GS_STRUCT_BINDING

#define GS_STRUCT_BINDING_NAMED_KEY	(	name,
		member,
		memberType
	)

カラム名を指定して、ユーザ定義構造体メンバとロウキー付き基本型カラムスキーマとの対応関係を定義します。

Parameters

name	カラム名
member	構造体メンバの名前
memberType	基本型の名前

See Also: GS_STRUCT_BINDING

Functions エラー処理
GS_DLL_PUBLIC size_t GS_API_CALL	gsGetErrorStackSize (void *gsResource)
	指定のリソースに関する直前のエラー情報のスタックサイズを取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetErrorCode (void *gsResource, size_t stackIndex)
	指定のリソースに関する直前のエラーのエラーコードを取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorMessage (void gsResource, size_t stackIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーのメッセージを取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorLocation (void gsResource, size_t stackIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーのメッセージの内部モジュールのエラー位置情報を取得します。More...

GS_DLL_PUBLIC GSBool GS_API_CALL	gsIsTimeoutError (GSResult result)
	要求した処理が既定の時間内に終了しなかった場合に発生したエラーに該当するエラーコードかどうかを判定します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorName (void gsResource, size_t stackIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーのエラー名を取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorDescription (void gsResource, size_t stackIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーの説明内容を取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsGetErrorParameterCount (void *gsResource, size_t stackIndex)
	指定のリソースに関する直前のエラーに関するパラメータの個数を取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorParameterName (void gsResource, size_t stackIndex, size_t parameterIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーに関するパラメータの名前を取得します。More...

GS_DLL_PUBLIC size_t GS_API_CALL	gsFormatErrorParameterValue (void gsResource, size_t stackIndex, size_t parameterIndex, GSChar strBuf, size_t bufSize)
	指定のリソースに関する直前のエラーに関するパラメータの値を取得します。More...

Detailed Description

エラー処理

Function Documentation

エラー処理

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorDescription	(	void *	gsResource,
		size_t	stackIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーの説明内容を取得します。

: 説明内容は、エラーメッセージのうち、エラー番号・エラー名を除いた部分に相当します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[out]	strBuf	エラーの説明内容を格納する文字列バッファ。gsFormatErrorMessageの同名の引数と同様です。
[in]	bufSize	エラーの説明内容を格納する文字列バッファの終端文字を含む文字数。gsFormatErrorMessageの同名の引数と同様です。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

Since: 4.2

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorLocation	(	void *	gsResource,
		size_t	stackIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーのメッセージの内部モジュールのエラー位置情報を取得します。

: 設定によっては常に空文字列しか求まらない場合があります。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[out]	strBuf	エラー位置情報を格納する文字列バッファ。gsFormatErrorMessageの同名の引数と同様です。
[in]	bufSize	エラー位置情報を格納する文字列バッファの終端文字を含む文字数。gsFormatErrorMessageの同名の引数と同様です。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorMessage	(	void *	gsResource,
		size_t	stackIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーのメッセージを取得します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[out]	strBuf	エラーメッセージを格納する文字列バッファ。`NULL`の場合、有効な結果を取得できません。`NULL`ではなく、別の原因で有効な結果が取得できなかった場合、`bufSize`が正の値であれば空文字列を格納します。
[in]	bufSize	エラーメッセージを格納する文字列バッファの終端文字を含む文字数。格納する文字列の終端文字を含む文字数の方が大きい場合、終端文字を除く後方の文字列を切り詰めて格納します。`0`の場合、文字列バッファにアクセスしません。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorName	(	void *	gsResource,
		size_t	stackIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーのエラー名を取得します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[out]	strBuf	エラー名を格納する文字列バッファ。gsFormatErrorMessageの同名の引数と同様です。
[in]	bufSize	エラー名を格納する文字列バッファの終端文字を含む文字数。gsFormatErrorMessageの同名の引数と同様です。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

Since: 4.2

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorParameterName	(	void *	gsResource,
		size_t	stackIndex,
		size_t	parameterIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーに関するパラメータの名前を取得します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[in]	parameterIndex	エラーに関するパラメータ集合のインデックス。`0`以上、かつ、パラメータの個数未満の値を指定した場合のみ、有効な結果を取得できます。
[out]	strBuf	パラメータ名を格納する文字列バッファ。gsFormatErrorMessageの同名の引数と同様です。
[in]	bufSize	パラメータ名を格納する文字列バッファの終端文字を含む文字数。gsFormatErrorMessageの同名の引数と同様です。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

See Also: gsGetErrorParameterCount

Since: 4.2

GS_DLL_PUBLIC size_t GS_API_CALL gsFormatErrorParameterValue	(	void *	gsResource,
		size_t	stackIndex,
		size_t	parameterIndex,
		GSChar *	strBuf,
		size_t	bufSize
	)

指定のリソースに関する直前のエラーに関するパラメータの値を取得します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。
[in]	parameterIndex	エラーに関するパラメータ集合のインデックス。gsFormatErrorParameterNameの同名の引数と同様です。
[out]	strBuf	パラメータ値を格納する文字列バッファ。gsFormatErrorMessageの同名の引数と同様です。
[in]	bufSize	パラメータ値を格納する文字列バッファの終端文字を含む文字数。gsFormatErrorMessageの同名の引数と同様です。

Returns: 終端文字を含んだ、出力に必要とする文字列バッファのバイト単位の最低サイズ。該当する情報を取得できなかった場合、0

See Also: gsGetErrorParameterCount

Since: 4.2

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetErrorCode	(	void *	gsResource,
		size_t	stackIndex
	)

指定のリソースに関する直前のエラーのエラーコードを取得します。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。`0`以上スタックサイズ未満の値を指定した場合のみ、有効な結果を取得できます。

Returns: エラーコード。該当する情報を取得できなかった場合、GS_RESULT_OK以外の値

GS_DLL_PUBLIC size_t GS_API_CALL gsGetErrorParameterCount	(	void *	gsResource,
		size_t	stackIndex
	)

指定のリソースに関する直前のエラーに関するパラメータの個数を取得します。

: エラーに関する内容のうち、特定の情報についてはパラメータとして取り出すことができます。各パラメータは、名前と値を持ちます。パラメータの個数に基づく各インデックス値を通じ、順不同にパラメータを列挙することができます。取得できるパラメータについては、エラーを引き起こした操作に関する、個々のインタフェースまたは関連するインタフェースの定義を参照してください。

: 取得できるパラメータの内容は、gsFormatErrorMessageもしくはgsFormatErrorDescriptionより求まる文字列にも原則として含まれます。一方、この文字列から特定の情報だけを一定の文字列解析規則で取り出せるとは限りません。特定のバージョンのある状況下では取り出せたとしても、別の条件では意図しない情報が求まるなどして取り出せない可能性があります。エラーに関するパラメータを個々に取得することで、インタフェースの定義で明記された一部の情報については、文字列解析を行わずに取り出せます。

: エラーに関するパラメータだけを記録し、メッセージ文字列などその他のエラー内容を記録しなかった場合、記録された内容からエラーの原因を特定することが困難となる可能性があります。

Parameters

[in]	gsResource	リソースのアドレス。gsGetErrorStackSizeの同名の引数と同様です。
[in]	stackIndex	エラースタックのインデックス。gsGetErrorCodeの同名の引数と同様です。

Returns: エラーに関するパラメータの個数。該当する情報を取得できなかった場合、0

Since: 4.2

GS_DLL_PUBLIC size_t GS_API_CALL gsGetErrorStackSize ( void * gsResource )

指定のリソースに関する直前のエラー情報のスタックサイズを取得します。

: エラー情報はスタック構造になっており、スタック番号の大きいものほどより直接的なエラー原因と対応します。

Parameters

[in] gsResource リソースのアドレス。ここでのリソースとは、GSGridStoreFactoryインスタンス、または、GSGridStoreFactoryを介して生成された、クローズ関数により破棄可能なリソースのことです。NULLが指定された場合、有効な結果を取得できません。

Returns: スタックサイズ。該当する情報を取得できなかった場合、0

GS_DLL_PUBLIC GSBool GS_API_CALL gsIsTimeoutError ( GSResult result )

要求した処理が既定の時間内に終了しなかった場合に発生したエラーに該当するエラーコードかどうかを判定します。

Returns: 該当するエラーコードかどうか

Since: 1.5

Typedefs GSAggregationResult
typedef struct GSAggregationResultTag	GSAggregationResult
	集計演算の結果を保持します。More...

Functions GSAggregationResult
GS_DLL_PUBLIC void GS_API_CALL	gsCloseAggregationResult (GSAggregationResult **aggregationResult)
	指定のGSAggregationResultインスタンスを解放します。More...

GS_DLL_PUBLIC GSBool GS_API_CALL	gsGetAggregationValue (GSAggregationResult aggregationResult, void value, GSType valueType)
	集計結果を指定の型の値として取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetAggregationValueAsLong (GSAggregationResult aggregationResult, int64_t value, GSBool *assigned)
	数値型の集計値をLONG型(`int64_t`)として取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetAggregationValueAsDouble (GSAggregationResult aggregationResult, double value, GSBool *assigned)
	数値型の集計値をDOUBLE型(`double`)として取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetAggregationValueAsTimestamp (GSAggregationResult aggregationResult, GSTimestamp value, GSBool *assigned)
	時刻型の集計値を通常精度のTIMESTAMP型(GSTimestamp)で取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetAggregationValueAsPreciseTimestamp (GSAggregationResult aggregationResult, GSPreciseTimestamp value, GSBool *assigned)
	時刻型の集計値を高精度のTIMESTAMP型(GSPreciseTimestamp)で取得します。More...

Detailed Description

GSAggregationResult

Typedef Documentation

GSAggregationResult

typedef struct GSAggregationResultTag GSAggregationResult

集計演算の結果を保持します。

: gsGetNextAggregationもしくはgsAggregateTimeSeriesにより取得できる、集計演算の結果を保持します。整数型カラムに対する演算結果を浮動小数点型として、また、有効桁数の少ない数値型のカラムに対する演算結果をより桁数の多い数値型として受け取ることができます。

: 保持する型は、集計演算の種別や集計対象のカラムの型によって決定されます。具体的な規則はGSAggregationまたはTQLの仕様を参照してください。

: 取り出しできる型は、保持する型によって決まります。保持する型が数値型の場合はDOUBLE型またはLONG型、TIMESTAMP型の場合はTIMESTAMP型の値としてのみ取り出しできます。

Function Documentation

GSAggregationResult

GS_DLL_PUBLIC void GS_API_CALL gsCloseAggregationResult ( GSAggregationResult ** aggregationResult )

指定のGSAggregationResultインスタンスを解放します。

Parameters

[in,out] aggregationResult クローズ対象のGSAggregationResultインスタンスを指しているポインタ変数へのポインタ値。クローズすると、ポインタ変数にNULLが設定されます。以後、解放したGSAggregationResultインスタンスにアクセスしてはなりません。ポインタ値またはポインタ変数の値がNULLの場合は、クローズ処理を行いません。

GS_DLL_PUBLIC GSBool GS_API_CALL gsGetAggregationValue	(	GSAggregationResult *	aggregationResult,
		void *	value,
		GSType	valueType
	)

集計結果を指定の型の値として取得します。

取り出しできる型は、指定のaggregationResultが保持している値の型によって、次のように決まります。

取り出しできる値の型	保持している値の型
LONG型(GS_TYPE_LONG)	数値型
DOUBLE型(GS_TYPE_DOUBLE)	数値型
TIMESTAMP型(GS_TYPE_TIMESTAMP)	TIMESTAMP型

また、valueとして指定できる型は、valueTypeによって次のように決まります。

`valueType`	`value`の型
LONG型(GS_TYPE_LONG)	int64_t*
DOUBLE型(GS_TYPE_DOUBLE)	double*
TIMESTAMP型(GS_TYPE_TIMESTAMP)	GSTimestamp*

Attention: valueTypeとvalueの型との対応が正しくない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	aggregationResult	処理対象のGSAggregationResult
[out]	value	取り出す値を格納するための変数へのポインタ値。`aggregationResult`が`NULL`の場合、また、`valueType`が`value`として指定できる型のいずれとも対応しない場合は、何も格納しません。`aggregationResult`が保持している値の型と照らし合わせて、`valueType`が取り出しできない型であった場合、初期値として`0`を格納します。
[in]	valueType	取り出す値の型

Returns

指定のaggregationResultが保持している値を取り出しできたかどうか。次の場合、GS_FALSEを返します。

valueTypeとして取り出しできない型が指定された場合
ポインタ型引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetAggregationValueAsDouble	(	GSAggregationResult *	aggregationResult,
		double *	value,
		GSBool *	assigned
	)

数値型の集計値をDOUBLE型(double)として取得します。

: 数値型以外の値を保持している場合、assigned引数にはGS_FALSEが格納されます。DOUBLE型以外の数値を保持している場合、DOUBLE型に変換したものが格納されます。

Parameters

[in]	aggregationResult	取得対象のGSAggregationResult
[out]	value	集計値を格納するための変数へのポインタ値
[out]	assigned	期待の型の値を取得できたかどうかを格納するための変数へのポインタ値。`NULL`が指定された場合、取得できたかどうかの情報は格納されません

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

assigned以外の引数にNULLが指定された場合

Since: 3.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetAggregationValueAsLong	(	GSAggregationResult *	aggregationResult,
		int64_t *	value,
		GSBool *	assigned
	)

数値型の集計値をLONG型(int64_t)として取得します。

: 数値型以外の値を保持している場合、assigned引数にはGS_FALSEが格納されます。LONG型以外の数値を保持している場合、LONG型に変換したものが格納されます。

Parameters

[in]	aggregationResult	取得対象のGSAggregationResult
[out]	value	集計値を格納するための変数へのポインタ値
[out]	assigned	期待の型の値を取得できたかどうかを格納するための変数へのポインタ値。`NULL`が指定された場合、取得できたかどうかの情報は格納されません

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

assigned以外の引数にNULLが指定された場合

Since: 3.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetAggregationValueAsPreciseTimestamp	(	GSAggregationResult *	aggregationResult,
		GSPreciseTimestamp *	value,
		GSBool *	assigned
	)

時刻型の集計値を高精度のTIMESTAMP型(GSPreciseTimestamp)で取得します。

: TIMESTAMP型以外の値を保持している場合、assigned引数にはGS_FALSEが格納されます。

: 高精度のTIMESTAMP値を保持している場合、通常精度の値に変換したものが求まります。

Parameters

[in]	aggregationResult	取得対象のGSAggregationResult
[out]	value	集計値を格納するための変数へのポインタ値
[out]	assigned	期待の型の値を取得できたかどうかを格納するための変数へのポインタ値。`NULL`が指定された場合、取得できたかどうかの情報は格納されません

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

assigned以外の引数にNULLが指定された場合

Since: 5.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetAggregationValueAsTimestamp	(	GSAggregationResult *	aggregationResult,
		GSTimestamp *	value,
		GSBool *	assigned
	)

時刻型の集計値を通常精度のTIMESTAMP型(GSTimestamp)で取得します。

: TIMESTAMP型以外の値を保持している場合、assigned引数にはGS_FALSEが格納されます。

: 通常精度のTIMESTAMP値を保持している場合、高精度の値に変換したものが求まります。

Parameters

[in]	aggregationResult	取得対象のGSAggregationResult
[out]	value	集計値を格納するための変数へのポインタ値
[out]	assigned	期待の型の値を取得できたかどうかを格納するための変数へのポインタ値。`NULL`が指定された場合、取得できたかどうかの情報は格納されません

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

assigned以外の引数にNULLが指定された場合

Since: 3.5

Classes GSCollection
struct	GSCollectionPropertiesTag
	コレクションの構成オプションを表します。More...

Macros GSCollection
#define	GS_COLLECTION_PROPERTIES_INITIALIZER { 0 }
	GSCollectionPropertiesの初期化子です。

Typedefs GSCollection
typedef GSContainer	GSCollection
	ロウ集合を汎用的に管理するためのコンテナです。More...

typedef GSEnum	GSGeometryOperator

typedef struct GSCollectionPropertiesTag	GSCollectionProperties
	コレクションの構成オプションを表します。More...

Enumerations GSCollection
enum	GSGeometryOperatorTag { GS_GEOMETRY_OPERATOR_INTERSECT }
	空間範囲同士の関係性についての制約を定義します。More...

Functions GSCollection
GS_DLL_PUBLIC GSResult GS_API_CALL	gsQueryByGeometry (GSCollection collection, const GSChar column, const GSChar geometry, GSGeometryOperator geometryOp, GSQuery *query)
	指定した空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsQueryByGeometryWithDisjointCondition (GSCollection collection, const GSChar column, const GSChar geometryIntersection, const GSChar geometryDisjoint, GSQuery **query)
	除外範囲付きの空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。More...

Detailed Description

Typedef Documentation

typedef GSContainer GSCollection

ロウ集合を汎用的に管理するためのコンテナです。

ロウキーには次の型が使用できます。

STRING型(GSChar*)
INTEGER型(int32_t)
LONG型(int64_t)
TIMESTAMP型(GSTimestamp)

: ロウキーの設定は必須ではありません。

: ロウ操作について、コンテナ固有の制限は設けられていません。

: gsQueryもしくはgsGetMultipleContainerRowsなどより複数のロウの内容を一度に取得する場合、特に指定がなければ、返却されるロウの順序は不定となります。

: ロック粒度はロウ単位です。

typedef struct GSCollectionPropertiesTag GSCollectionProperties

コレクションの構成オプションを表します。

Note: 現バージョンでは使用されておりません。

typedef GSEnum GSGeometryOperator

See Also: GSGeometryOperatorTag

Enumeration Type Documentation

enum GSGeometryOperatorTag

空間範囲同士の関係性についての制約を定義します。

: 空間範囲検索の条件指定のために使用します。

Enumerator

GS_GEOMETRY_OPERATOR_INTERSECT

双方の空間範囲またはその外接構造が交差する関係にあることを示します。

: 双方の外接直方体(Minimum Bounding Box)、もしくは外接直方体と2次曲面が交差する関係にあることを示します。交差判定の条件は、TQLのST_MBRIntersects関数、もしくはST_QSFMBRIntersects関数と同一です。

Function Documentation

GS_DLL_PUBLIC GSResult GS_API_CALL gsQueryByGeometry	(	GSCollection *	collection,
		const GSChar *	column,
		const GSChar *	geometry,
		GSGeometryOperator	geometryOp,
		GSQuery **	query
	)

指定した空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。

: gsFetchを通じてロウ集合を求める際、更新用ロックのオプションを有効にすることもできます。

Parameters

[in]	collection	処理対象のGSCollection
[in]	column	比較対象の空間型カラムの名前
[in]	geometry	比較対象として与える空間構造
[in]	geometryOp	比較方法
[out]	query	GSQueryインスタンスを格納するためのポインタ変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、このポインタ値が`NULL`以外の値であれば、対応するポインタ変数に`NULL`が格納されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

指定のコンテナの種別がコレクションではない場合
対応する名前のカラムが存在しない場合
geometryOp以外の引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsQueryByGeometryWithDisjointCondition	(	GSCollection *	collection,
		const GSChar *	column,
		const GSChar *	geometryIntersection,
		const GSChar *	geometryDisjoint,
		GSQuery **	query
	)

除外範囲付きの空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。

: geometryIntersectionと交差し、かつ、geometryDisjointと交差しないカラム値を持つロウ集合を取得します。交差判定の条件は、GS_GEOMETRY_OPERATOR_INTERSECTと同一です。

: gsFetchを通じてロウ集合を求める際、更新用ロックのオプションを有効にすることもできます。

Parameters

[in]	collection	処理対象のGSCollection
[in]	column	比較対象の空間型カラムの名前
[in]	geometryIntersection	カラム上の値と交差する範囲を示す空間構造
[in]	geometryDisjoint	上の値と交差しない範囲を示す空間構造
[out]	query	GSQueryインスタンスを格納するためのポインタ変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、このポインタ値が`NULL`以外の値であれば、対応するポインタ変数に`NULL`が格納されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

指定のコンテナの種別がコレクションではない場合
対応する名前のカラムが存在しない場合
引数にNULLが指定された場合

Classes GSContainer
struct	GSColumnInfoTag
	カラムのスキーマに関する情報を表します。More...

struct	GSTriggerInfoTag
	トリガに関する情報を表します。More...

struct	GSIndexInfoTag
	索引の設定内容を表します。More...

struct	GSContainerInfoTag
	特定のコンテナに関する情報を表します。More...

Macros GSContainer
#define	GS_COLUMN_INFO_INITIALIZER { NULL, GS_TYPE_STRING, GS_INDEX_FLAG_DEFAULT, 0 }
	GSColumnInfoの初期化子です。

#define	GS_TRIGGER_INFO_INITIALIZER { NULL, GS_TRIGGER_REST, NULL, 0, NULL, 0, NULL, NULL, NULL }
	GSTriggerInfoの初期化子です。

#define	GS_INDEX_INFO_INITIALIZER { NULL, GS_INDEX_FLAG_DEFAULT, -1, NULL, 0, NULL, 0, NULL }
	GSIndexInfoの初期化子です。More...

#define	GS_CONTAINER_INFO_INITIALIZER
	GSContainerInfoの初期化子です。

Typedefs GSContainer
typedef struct GSContainerTag	GSContainer
	同一タイプのロウ集合からなるGridDBの構成要素に対しての、管理機能を提供します。More...

typedef int32_t	GSIndexTypeFlags

typedef GSEnum	GSContainerType

typedef int32_t	GSTypeOption
	カラムに関するオプション設定を示すフラグ値のビット和です。More...

typedef struct GSColumnInfoTag	GSColumnInfo
	カラムのスキーマに関する情報を表します。

typedef GSEnum	GSTriggerType

typedef int32_t	GSTriggerEventTypeFlags

typedef struct GSTriggerInfoTag	GSTriggerInfo
	トリガに関する情報を表します。More...

typedef struct GSIndexInfoTag	GSIndexInfo
	索引の設定内容を表します。More...

typedef struct GSContainerInfoTag	GSContainerInfo
	特定のコンテナに関する情報を表します。

Enumerations GSContainer
enum	GSIndexTypeFlagTag { GS_INDEX_FLAG_DEFAULT = -1, GS_INDEX_FLAG_TREE = 1 << 0, GS_INDEX_FLAG_HASH = 1 << 1, GS_INDEX_FLAG_SPATIAL = 1 << 2 }
	GSContainerに設定する索引の種別を示します。More...

enum	GSContainerTypeTag { GS_CONTAINER_COLLECTION, GS_CONTAINER_TIME_SERIES }
	コンテナの種別を表します。More...

enum	GSTypeOptionTag { GS_TYPE_OPTION_NULLABLE = 1 << 1, GS_TYPE_OPTION_NOT_NULL = 1 << 2, GS_TYPE_OPTION_DEFAULT_VALUE_NULL = 1 << 3, GS_TYPE_OPTION_DEFAULT_VALUE_NOT_NULL = 1 << 4, GS_TYPE_OPTION_TIME_MILLI = 1 << 5, GS_TYPE_OPTION_TIME_MICRO = 1 << 6, GS_TYPE_OPTION_TIME_NANO = 1 << 7 }
	カラムに関するオプション設定を示します。More...

enum	GSTriggerTypeTag { GS_TRIGGER_REST, GS_TRIGGER_JMS }
	トリガの種別を表します。More...

enum	GSTriggerEventTypeFlagTag { GS_TRIGGER_EVENT_PUT = 1 << 0, GS_TRIGGER_EVENT_DELETE = 1 << 1 }
	トリガで監視対象とする更新操作種別を表します。More...

Functions GSContainer
GS_DLL_PUBLIC void GS_API_CALL	gsCloseContainer (GSContainer **container, GSBool allRelated)
	指定のGSContainerインスタンスについて、必要に応じこのインスタンスならびに関連するリソースを解放します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateTrigger (GSContainer container, const GSTriggerInfo info)
	トリガを設定します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateIndex (GSContainer container, const GSChar columnName, GSIndexTypeFlags flags)
	指定された名前のカラムに対し、指定された種別で名前のない索引を作成します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsCreateIndexDetail (GSContainer container, const GSIndexInfo info)
	GSIndexInfoで設定されている内容に従い、索引を作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDropTrigger (GSContainer container, const GSChar name)
	トリガを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDropIndex (GSContainer container, const GSChar columnName, GSIndexTypeFlags flags)
	指定された名前のカラムのうち、指定された種別の索引のみを削除します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsDropIndexDetail (GSContainer container, const GSIndexInfo info)
	GSIndexInfoで設定されている内容に一致する、すべての索引を削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsFlush (GSContainer *container)
	これまでの更新結果をSSDなどの不揮発性記憶媒体に書き出し、すべてのクラスタノードが突然停止したとしても内容が失われないようにします。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRow (GSContainer container, const void key, void rowObj, GSBool exists)
	ロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRow (GSContainer container, const void key, const void rowObj, GSBool exists)
	必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutMultipleRows (GSContainer container, const void const rowObjs, size_t rowCount, GSBool exists)
	指定のロウオブジェクト集合に基づき、任意個数のロウをまとめて新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsQuery (GSContainer container, const GSChar queryString, GSQuery **query)
	指定のTQL文を実行するためのクエリを作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRow (GSContainer container, const void key, GSBool *exists)
	指定のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetContainerType (GSContainer container, GSContainerType type)
	指定のコンテナの種別を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateRowByContainer (GSContainer container, GSRow *row)
	指定のコンテナのカラムレイアウトに基づき、ロウオブジェクトを新規作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsAbort (GSContainer *container)
	手動コミットモードにおいて、現在のトランザクションの操作結果を元に戻し、新たなトランザクションを開始します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCommit (GSContainer *container)
	手動コミットモードにおいて、現在のトランザクションにおける操作結果を確定させ、新たなトランザクションを開始します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowForUpdate (GSContainer container, const void key, void rowObj, GSBool exists)
	ロウキーに対応するロウについて、更新用ロックを獲得し内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsSetAutoCommit (GSContainer *container, GSBool enabled)
	コミットモードの設定を変更します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowByInteger (GSContainer container, int32_t key, void rowObj, GSBool forUpdate, GSBool *exists)
	INTEGER型のロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowByLong (GSContainer container, int64_t key, void rowObj, GSBool forUpdate, GSBool *exists)
	LONG型のロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowByTimestamp (GSContainer container, GSTimestamp key, void rowObj, GSBool forUpdate, GSBool *exists)
	通常精度のTIMESTAMP型のロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowByPreciseTimestamp (GSContainer container, const GSPreciseTimestamp key, void rowObj, GSBool forUpdate, GSBool exists)
	高精度のTIMESTAMP型のロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowByString (GSContainer container, const GSChar key, void rowObj, GSBool forUpdate, GSBool exists)
	STRING型のロウキーに対応するロウの内容を取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowByInteger (GSContainer container, int32_t key, const void rowObj, GSBool *exists)
	INTEGER型のロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowByLong (GSContainer container, int64_t key, const void rowObj, GSBool *exists)
	LONG型のロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowByTimestamp (GSContainer container, GSTimestamp key, const void rowObj, GSBool *exists)
	通常精度のTIMESTAMP型のロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowByPreciseTimestamp (GSContainer container, const GSPreciseTimestamp key, const void rowObj, GSBool exists)
	高精度のTIMESTAMP型のロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowByString (GSContainer container, const GSChar key, const void rowObj, GSBool exists)
	STRING型のロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowByInteger (GSContainer container, int32_t key, GSBool exists)
	INTEGER型のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowByLong (GSContainer container, int64_t key, GSBool exists)
	LONG型のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowByTimestamp (GSContainer container, GSTimestamp key, GSBool exists)
	通常精度のTIMESTAMP型のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowByPreciseTimestamp (GSContainer container, const GSPreciseTimestamp key, GSBool *exists)
	高精度のTIMESTAMP型のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowByString (GSContainer container, const GSChar key, GSBool *exists)
	STRING型のロウキーに対応するロウを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetRowGeneral (GSContainer container, GSRowKey keyObj, GSRow rowObj, GSBool forUpdate, GSBool exists)
	指定のGSRowKeyに対応するロウの内容をGSRowとして取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutRowGeneral (GSContainer container, GSRowKey keyObj, GSRow rowObj, GSBool exists)
	必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDeleteRowGeneral (GSContainer container, GSRowKey keyObj, GSBool *exists)
	指定のロウキーに対応するロウを削除します。More...

Detailed Description

Macro Definition Documentation

#define GS_INDEX_INFO_INITIALIZER { NULL, GS_INDEX_FLAG_DEFAULT, -1, NULL, 0, NULL, 0, NULL }

GSIndexInfoの初期化子です。

Since: 3.5

Typedef Documentation

typedef struct GSContainerTag GSContainer

同一タイプのロウ集合からなるGridDBの構成要素に対しての、管理機能を提供します。

: ロウオブジェクトを入出力の基本単位として、各種管理機能を提供します。ロウオブジェクトとGridDB上のロウは、指定のロウオブジェクト型とGridDB上のスキーマとの対応関係に基づいて、相互にマッピングされます。

: GridDB上のスキーマを構成する各カラムは、対応するGS_STRUCT_BINDINGの内容に基づき決定されます。1つのコンテナは1つ以上のカラムにより構成されます。

: 1つのコンテナのカラム間で、ASCIIの大文字・小文字表記だけが異なる名前のものを複数定義することはできません。その他、コンテナ定義におけるカラム名の文字種や長さ、カラム数には制限があります。具体的には、GridDB機能リファレンスを参照してください。特に記載のない限り、カラム名を指定する操作では、ASCIIの大文字・小文字表記の違いは区別されません。

カラムの型と、ロウオブジェクト内の各値の型との対応は、それぞれ次の通りです。

カラム型	ロウオブジェクト内の各値の型
STRING	GSChar*
BOOL	GSBool
BYTE	int8_t
SHORT	int16_t
INTEGER	int32_t
LONG	int64_t
FLOAT	float
DOUBLE	double
TIMESTAMP(通常精度:ミリ秒)	GSTimestamp
TIMESTAMP(高精度:マイクロ・ナノ秒)	GSPreciseTimestamp
GEOMETRY	GSChar*
BLOB	GSBlob
STRING配列	GSChar**
BOOL配列	GSBool*
BYTE配列	int8_t*
SHORT配列	int16_t*
INTEGER配列	int32_t*
LONG配列	int64_t*
FLOAT配列	float*
DOUBLE配列	double*
TIMESTAMP配列	GSTimestamp*

: フィールドの値の表現範囲やサイズには制限があります。具体的には、付録の章の値の範囲の説明、ならびに、GridDB機能リファレンスを参照してください。制限に反する値をコンテナに格納することはできません。

: ロウキーとして許可されている型や、ロウキーに対応するカラムの有無、ロウ更新の可否といった制約は、このコンテナ型から派生した個別の型の定義によって異なります。

: GridDB上のロウにおけるNULLは、NOT NULL制約が設定されていない限り保持することができます。NULLは、GSRowを通じて格納や取り出しを行うことができます。一方、GS_STRUCT_BINDINGと対応付くロウオブジェクトにおいては、常に後述の空の値にマッピングされます。

: ロウオブジェクト型におけるNOT NULL制約は、GS_TYPE_OPTION_NULLABLEならびにGS_TYPE_OPTION_NOT_NULLにより明示的に指定できます。NOT NULL制約がいずれの指定対象にも指定されていない場合、ロウキー以外のカラムはNOT NULL制約なしであるとみなされます。ロウキーは暗黙的にNOT NULL制約が設定された状態となっており、この制約を外すような指定はできません。また、同一指定対象での矛盾したNOT NULL制約は指定できません。NOT NULL制約は、GSColumnInfoTag::optionsを通じて指定することができます。

空の値は、GSRowの作成など各種操作の初期値などとして用いられることのある、フィールド値の一種です。以下のように、カラム型ごとに値が定義されています。

カラム型	空の値
STRING	`""` (長さ0の文字列)
BOOL	偽(GS_FALSE)
数値型	`0`
TIMESTAMP	`1970-01-01T00:00:00Z`
GEOMETRY	`POINT(EMPTY)`
BLOB	長さ0のBLOBデータ
配列型	要素数0の配列

: 日時精度は、GSTypeOptionの日時精度に関するオプションにより明示的に指定できます。

: トランザクション処理では、デフォルトで自動コミットモードが有効になっています。自動コミットモードでは、変更操作は逐次確定し、明示的に取り消すことができません。手動コミットモードにおいて、GSContainerインスタンスを介した操作によりクラスタノード上でエラーが検出された場合、コミット前の更新操作はすべて取り消されます。トランザクション分離レベルはREAD COMMITTEDのみをサポートします。ロック粒度は、コンテナの種別によって異なります。

: ロウの更新・追加・削除、ならびに更新用ロック獲得を行った場合、内部でトランザクションが生成されます。このトランザクションには、有効期限が存在します。これらの操作をあるGSContainerインスタンスに対してはじめて行った時刻を起点として、GridDB上で定められている期間だけ経過した後に、さらに同様の操作やトランザクション操作を行おうとすると、該当するGSContainerインスタンスを介した以降の操作は常に失敗するようになります。

: あるコンテナへの操作要求に対するクラスタノード上での処理が開始され、終了するまでの間、同一のコンテナに対する操作が待機させられる場合があります。ここでの操作には、コンテナのスキーマや索引などの定義変更、コンテナ情報の参照、ロウ操作などが含まれます。一貫性レベルがIMMEDIATEのGSGridStoreインスタンスを通じてコンテナを操作する場合、同一のコンテナに対するIMMEDIATE設定での他の操作処理の途中、原則としては待機させられます。また、コンテナに対する他の操作処理の途中の状態に基づいて処理が行われることは、原則としてはありません。例外事項については、個別の操作ごとの説明を参照してください。

typedef GSEnum GSContainerType

See Also: GSContainerTypeTag

typedef struct GSIndexInfoTag GSIndexInfo

索引の設定内容を表します。

Since: 3.5

typedef int32_t GSIndexTypeFlags

See Also: GSIndexTypeFlagTag

typedef int32_t GSTriggerEventTypeFlags

See Also: GSTriggerEventTypeFlagTag

typedef struct GSTriggerInfoTag GSTriggerInfo

トリガに関する情報を表します。

Since: 1.5

typedef GSEnum GSTriggerType

See Also: GSTriggerTypeTag

typedef int32_t GSTypeOption

カラムに関するオプション設定を示すフラグ値のビット和です。

ある設定項目について、対応するフラグ値が複数含まれていた場合に、オプション設定が矛盾しているとみなされるものが存在します。それらの設定項目のうち、対応するフラグ値が一つも含まれていないものは、未設定状態であるとみなされます。この制約に該当する設定項目とフラグ値との対応は次の通りです。

設定項目	フラグ値
NOT NULL制約	GS_TYPE_OPTION_NULLABLE GS_TYPE_OPTION_NOT_NULL
初期値でのNULL使用有無	GS_TYPE_OPTION_DEFAULT_VALUE_NULL GS_TYPE_OPTION_DEFAULT_VALUE_NOT_NULL

See Also: GSTypeOptionTag

Enumeration Type Documentation

enum GSContainerTypeTag

コンテナの種別を表します。

Enumerator
GS_CONTAINER_COLLECTION	対象のコンテナがコレクションであることを示します。
GS_CONTAINER_TIME_SERIES	対象のコンテナが時系列であることを示します。

enum GSIndexTypeFlagTag

GSContainerに設定する索引の種別を示します。

Enumerator
GS_INDEX_FLAG_DEFAULT	デフォルトの索引を示します。この索引種別は、特定の種別を明示せずに索引の操作を行う必要がある場合に用いられるものであり、実在する索引はこの種別以外の種別に分類されます。
GS_INDEX_FLAG_TREE	ツリー索引を示します。この索引種別は、時系列におけるロウキーと対応するカラムを除く任意の種別のコンテナにおける、次の型のカラムに対して使用できます。 STRING BOOL BYTE SHORT INTEGER LONG FLOAT DOUBLE TIMESTAMP
GS_INDEX_FLAG_HASH	ハッシュ索引を示します。この索引は、GSCollectionにおける次の型のカラムに対して設定できます。 STRING BOOL BYTE SHORT INTEGER LONG FLOAT DOUBLE TIMESTAMP GSTimeSeriesに対して設定することはできません。
GS_INDEX_FLAG_SPATIAL	空間索引を示します。この索引種別は、GSCollectionにおけるGEOMETRY型のカラムに対してのみ使用できます。GSTimeSeriesに対して設定することはできません。

enum GSTriggerEventTypeFlagTag

トリガで監視対象とする更新操作種別を表します。

Enumerator
GS_TRIGGER_EVENT_PUT	コンテナに対するロウ新規作成または更新を示します。
GS_TRIGGER_EVENT_DELETE	コンテナに対するロウ削除を示します。

enum GSTriggerTypeTag

トリガの種別を表します。

Enumerator
GS_TRIGGER_REST	コンテナの更新時にRESTで通知するトリガ種別を示します。
GS_TRIGGER_JMS	コンテナの更新時にJava Message Service(JMS)で通知するトリガ種別を示します。

enum GSTypeOptionTag

カラムに関するオプション設定を示します。

See Also: GSTypeOption

Enumerator
GS_TYPE_OPTION_NULLABLE	NOT NULL制約を持たないカラムであることを示します。 Since 3.5
GS_TYPE_OPTION_NOT_NULL	NOT NULL制約を持つカラムであることを示します。 Since 3.5
GS_TYPE_OPTION_DEFAULT_VALUE_NULL	初期値としてNULLを使用するカラムであることを示します。 Since 4.1
GS_TYPE_OPTION_DEFAULT_VALUE_NOT_NULL	初期値としてNULLを使用しないカラムであることを示します。 Since 4.1
GS_TYPE_OPTION_TIME_MILLI	ミリ秒単位で保持する通常精度の日時型カラムであることを示します。日時型カラムの定義において、精度のオプションが指定されなかった場合、この通常精度のオプションが選択されたものとみなされます。 Since 5.3
GS_TYPE_OPTION_TIME_MICRO	マイクロ秒単位で保持する高精度の日時型カラムであることを示します。 Since 5.3
GS_TYPE_OPTION_TIME_NANO	ナノ秒単位で保持する高精度の日時型カラムであることを示します。 Since 5.3

Function Documentation

GS_DLL_PUBLIC GSResult GS_API_CALL gsAbort ( GSContainer * container )

手動コミットモードにおいて、現在のトランザクションの操作結果を元に戻し、新たなトランザクションを開始します。

Parameters

[in] container 処理対象のGSContainer

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

自動コミットモードであるにもかかわらず呼び出した場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除、接続障害が発生した場合
引数にNULLが指定された場合

GS_DLL_PUBLIC void GS_API_CALL gsCloseContainer	(	GSContainer **	container,
		GSBool	allRelated
	)

指定のGSContainerインスタンスについて、必要に応じこのインスタンスならびに関連するリソースを解放します。

: トランザクションを保持している場合、未コミットの更新内容はすべて元に戻されます。

: この処理を行うために接続障害が発生したとしても、ローカルリソースの解放処理は適宜実施されます。ただし、GridDB上のトランザクション状態などは状態などは残る可能性があります。

Parameters

[in,out]	container	クローズ対象のGSContainerインスタンスを指しているポインタ変数へのポインタ値。クローズすると、ポインタ変数に`NULL`が設定されます。以後、解放したGSContainerインスタンスにアクセスしてはなりません。ポインタ値またはポインタ変数の値が`NULL`の場合は、クローズ処理を行いません。
[in]	allRelated	指定のGSContainerと関連する下位のリソースのうち、未クローズのものすべてをクローズするかどうか。関連する下位のリソースとは、指定のGSContainerを介して取得したGSQuery、GSAggregationResult、ならびに、これらのリソースと関連する下位のリソースのことを指します。GS_FALSEを指定した場合、指定のGSContainerを介して取得したリソースを個別にクローズする必要があり、すべてクローズした時点で指定のGSContainer自体のリソースが解放されます。

GS_DLL_PUBLIC GSResult GS_API_CALL gsCommit ( GSContainer * container )

手動コミットモードにおいて、現在のトランザクションにおける操作結果を確定させ、新たなトランザクションを開始します。

Parameters

[in] container 処理対象のGSContainer

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

自動コミットモードであるにもかかわらず呼び出した場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除、接続障害が発生した場合
引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsCreateIndex	(	GSContainer *	container,
		const GSChar *	columnName,
		GSIndexTypeFlags	flags
	)

指定された名前のカラムに対し、指定された種別で名前のない索引を作成します。

: カラム名と種別のみが設定されたGSIndexInfoを指定してgsCreateIndexDetailを呼び出した場合と同様に振る舞います。ただし、flagsにデフォルト種別を含め一つも種別が指定されていない場合、索引は作成されません。

Parameters

[in]	container	処理対象のGSContainer
[in]	columnName	処理対象のカラムの名前
[in]	flags	作成する索引種別のフラグ値のビット和。指定できる値はgsCreateIndexDetailの場合と同様です

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

指定のカラム名と種別がgsCreateIndexDetailの規則に合致しない場合
この処理のタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
flags以外の引数にNULLが指定された場合

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult gsCreateIndexDetail	(	GSContainer *	container,
		const GSIndexInfo *	info
	)

GSIndexInfoで設定されている内容に従い、索引を作成します。

: 作成対象の索引のカラムについては、カラム名列またはカラム番号列の少なくとも一方が設定されており、かつ、対応するコンテナにおいて実在するものが設定されている必要があります。カラム名列とカラム番号列が共に設定されている場合、対応するカラム列が順序を含め一致している必要があります。

: 索引種別が一つも設定されていないかGS_INDEX_FLAG_DEFAULTが設定されていた場合、後述の基準に従い、デフォルト種別の索引が選択されます。それ以外の場合、対象のカラムにおいて許されている索引種別である限り、一つ以上の種別を指定できます。複数個の種別が設定されていた場合、作成途中に一部の索引のみが作成された状態のコンテナ情報を参照できることや、エラーが生じるとその状態まま作成操作が終了することがあります。

: 1つのコンテナの索引間で、ASCIIの大文字・小文字表記だけが異なる名前のものを複数定義することはできません。その他、索引の定義において使用できる索引名の文字種や長さには制限があります。具体的には、GridDB機能リファレンスを参照してください。特に記載のない限り、索引名を指定する操作では、ASCIIの大文字・小文字表記の違いは区別されません。

: 既存の同名の索引が存在した場合、後述の条件を満たす同一設定のGSIndexInfoを指定しなければならず、その場合新たな索引は作成されません。一方、既存の異なる名前の索引または名前のない索引と同一設定のGSIndexInfoを指定することはできません。

: 索引名が設定されていない場合は、名前のない索引の作成が要求されたものとみなされます。名前を除いて同一設定の索引がすでに存在していた場合、名前のない索引でなければならず、その場合新たな索引は作成されません。

現バージョンでは、少なくともGSContainerを通じて作成された索引において、次の条件を満たす場合に索引名を除いて同一設定の索引であるとみなされます。

索引対象のカラム列が順序を含め一致すること。カラム名列、カラム番号列、単一カラム指定、といった、カラム列の指定方法の違いは無視される
索引種別が一致すること。デフォルト指定の有無といった索引種別の指定方法の違いは無視される

現バージョンにおける、gsGetDefaultFactoryを基に生成されたGSContainerインスタンスでは、コンテナの種別、対応するカラムの型などに基づき、次の索引種別がデフォルトとして選択されます。

カラムの型	コレクション	時系列
STRING	GS_INDEX_FLAG_TREE	GS_INDEX_FLAG_TREE
BOOL	GS_INDEX_FLAG_TREE	GS_INDEX_FLAG_TREE
数値型	GS_INDEX_FLAG_TREE	GS_INDEX_FLAG_TREE
TIMESTAMP	GS_INDEX_FLAG_TREE	GS_INDEX_FLAG_TREE※制限あり
GEOMETRY	GS_INDEX_FLAG_SPATIAL	(なし)
BLOB	(なし)	(なし)
配列型	(なし)	(なし)

: 時系列のロウキー(TIMESTAMP型)には索引を設定できません。また、カラム列を構成するカラム型によってデフォルト種別が異なる場合には、選択できません。

: このGSContainerインスタンスが未コミットのトランザクションを保持していた場合、コミットしてから作成を行います。処理対象のコンテナにおいて実行中の他のトランザクションが存在する場合、それらの終了を待機してから作成を行います。すでに索引が存在しており新たな索引が作成されなかった場合、他のトランザクションによって待機するかどうかは未定義です。またこの場合、このGSContainerインスタンスが保持している未コミットのトランザクションが常にコミットされるかどうかは未定義です。

: 現バージョンでは、コンテナの規模など諸条件を満たした場合、索引の作成開始から終了までの間に、処理対象のコンテナに対してコンテナ情報の参照、一部の索引操作、トリガ操作、ロウ操作(更新含む)を行える場合があります。それ以外の操作は、GSContainerでの説明通り待機させる場合があります。索引の作成途中に別の操作が行われる場合は、作成途中の索引に関する情報はコンテナ情報には含まれません。

Parameters

[in]	container	処理対象のGSContainer
[in]	info	処理対象の索引の情報

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

作成対象のカラム、索引名が上記の規則に合致しない場合
この処理のタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
指定のカラムにおいてサポートされていない索引種別が指定された場合
引数にNULLが指定された場合

Since: 3.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsCreateRowByContainer	(	GSContainer *	container,
		GSRow **	row
	)

指定のコンテナのカラムレイアウトに基づき、ロウオブジェクトを新規作成します。

: 作成されるGSRowの各フィールドにはgsCreateRowByStoreにより作成した場合と同様に既定の初期値が設定されます。

Parameters

[in]	container	処理対象のGSContainer
[out]	row	GSRowインスタンスを格納するためのポインタ変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、このポインタ値が`NULL`以外の値であれば、対応するポインタ変数に`NULL`が格納されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

引数にNULLが指定された場合

Since: 1.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsCreateTrigger	(	GSContainer *	container,
		const GSTriggerInfo *	info
	)

トリガを設定します。

: 指定のコンテナに対して特定の種別の更新操作が行われた場合に、指定のURIに通知が送信されるようになります。指定されたトリガと同名のトリガが存在した場合、設定内容が上書きされます。

: トリガ設定内容の詳細は、GSTriggerInfoの定義を参照してください。トリガ名、トリガ種別、通知条件、通知先URI、通知内容の詳細は以下の通りです。

トリガ名: トリガ種別や通知条件などの違いによらず、1つのコンテナのトリガ間で、ASCIIの大文字・小文字表記を含め同一の名前のものを複数定義することはできません。その他、トリガの定義において使用できるトリガ名の文字種や長さには制限があります。具体的には、GridDB機能リファレンスを参照してください。特に記載のない限り、トリガ名を指定する操作では、ASCIIの大文字・小文字表記の違いが区別されます。

トリガ種別

次のトリガ種別をサポートします。

名称	説明
REST	コンテナに指定された種別の更新操作が行われた際に、指定されたURIにREST(HTTP POSTメソッド)で通知するトリガです。
Java Message Service(JMS)	コンテナに指定された種別の更新操作が行われた際に、指定されたURIのJMSサーバへJMSメッセージを通知するトリガです。JMSプロバイダとしてApache ActiveMQを使用します。

通知条件: 指定のコンテナに対するロウ新規作成/更新(gsPutRow、gsPutMultipleRows、gsPutMultipleContainerRows、gsUpdateCurrentRow)・削除(gsDeleteRow、gsDeleteCurrentRow)操作命令の実行直後に通知を行います。監視対象として複数の操作が指定された場合は、そのうちのいずれかが実行された際に通知を行います。

: 通知を行った時点でのレプリケーションの完了は保証されません。自動コミットモード無効で実行されたロウ新規作成/更新・削除命令に対応する通知については、通知を行った時点でトランザクションが未コミットであったり、通知後にトランザクションがアボートされたりした場合、通知を受けた時点で通知に含まれるデータが取得できないことがあります。

: 複数ロウ一括操作の場合、1件のロウ操作ごとに通知を行います。指定されたURIに通知を行っても一定時間以内に応答がない場合、タイムアウトし再送は行いません。GridDBクラスタに障害が発生した場合、ある更新操作に対応する通知が行われないことのほか、複数回通知されることがあります。

通知先URI: 通知先URIは次の書式で記述します。
(メソッド名)://(ホスト名):(ポート番号)/(パス)

ただし、トリガ種別がRESTの場合、メソッド名にはhttpのみ指定できます。

通知内容: 更新が行われたコンテナ名、更新操作名、更新されたロウデータの指定したカラムの値を通知します。更新操作名は、ロウ新規作成/更新では"put"、削除では"delete"となります。

: 通知する値は、ロウ新規作成では新規作成直後、更新では更新後、削除では削除前のロウデータについての、指定カラムの値となります。カラムの型がTIMESTAMPの場合、1970-01-01T00:00:00Zからの経過ミリ秒を示す整数が値として設定されます。カラムの型が、BLOB型、GEOMETRY型、配列型の場合、空文字列が値として設定されます。

通知方法―RESTの場合: 以下のようなJSON文字列を、MIMEタイプapplication/jsonで送信します。
{

"container" : "(コンテナ名)",

"event" : "(更新操作名)",

"row" : {

"(カラム名)" : (カラムデータ),

"(カラム名)" : (カラムデータ),

...

}

}

通知方法―JMSの場合: javax.jms.TextMessageを、指定されたデスティネーション種別・デスティネーション名で送信します。

: コンテナ名は、javax.jms.Message::setStringProperty("@container", "(コンテナ名)")で設定されます。更新操作名は、javax.jms.Message::setStringProperty("@event", "(更新操作名)")で設定されます。

: カラムの値は、カラムの型に応じたjavax.jms.Message::setXXXProperty("(カラム名)", (カラムデータ))で設定されます。

: トリガが設定されているコンテナに対してgsPutCollection、gsPutTimeSeriesなどによりカラムレイアウトが変更された際に、トリガの通知対象となっているカラムの削除または名称変更があった場合、該当するカラムはトリガの通知対象から削除されます。

: GridDBからの通知の際に、設定されている通知先URIへのリクエストに対応するサーバが応答しなかった場合、タイムアウト時刻までの待機処理が発生します。この待機処理は、このコンテナならびに他の一部のコンテナの更新に対する通知が遅れる要因となります。したがって、無効となった通知先URIを持つトリガはgsDropTriggerにより削除することが推奨されます。

: 一つのコンテナに対して設定できるトリガの最大数、ならびに、トリガの各種設定値の上限については、GridDB機能リファレンスを参照してください。

Parameters

[in]	container	設定対象のGSContainer
[in]	info	設定対象のトリガ情報

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

トリガ名がNULL空、またはその他の規則に合致しない場合
監視対象更新操作の指定がない場合
通知先のURIが規定の構文に合致しない場合
トリガ種別でJMSが指定され、かつJMSデスティネーション種別がNULL、または空、または指定の書式に合致しない場合
トリガ種別でJMSが指定され、かつJMSデスティネーション名がNULL、または空の場合
この処理のタイムアウト、指定のコンテナの削除、接続障害が発生した場合
引数にNULLが指定された場合

Since: 1.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRow	(	GSContainer *	container,
		const void *	key,
		GSBool *	exists
	)

指定のロウキーに対応するロウを削除します。

: ロウキーに対応するカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: ただし、コンテナの種別ならびに設定によっては、制限が設けられています。圧縮オプションが設定された状態の時系列に対しては使用できません。

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトのロウキーの型と指定のロウキーの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキーが格納された変数へのポインタ値。GSContainerにおいて定義されているコンテナ上のロウキーの型とこの引数の型との関係は、gsGetRowの場合と同様です。
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして指定された場合
exists以外の引数にNULLが指定された場合。また、keyに対応する文字列キーのポインタ値がNULLの場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowByInteger	(	GSContainer *	container,
		int32_t	key,
		GSBool *	exists
	)

INTEGER型のロウキーに対応するロウを削除します。

: ロウキーに対応するINTEGER型のカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するINTEGER型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合

See Also: gsDeleteRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowByLong	(	GSContainer *	container,
		int64_t	key,
		GSBool *	exists
	)

LONG型のロウキーに対応するロウを削除します。

: ロウキーに対応するLONG型のカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するLONG型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合

See Also: gsDeleteRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowByPreciseTimestamp	(	GSContainer *	container,
		const GSPreciseTimestamp *	key,
		GSBool *	exists
	)

高精度のTIMESTAMP型のロウキーに対応するロウを削除します。

: ロウキーに対応する高精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: ただし、コンテナの種別ならびに設定によっては、制限が設けられています。圧縮オプションが設定された状態の時系列に対しては使用できません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する高精度のTIMESTAMP型のカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして指定された場合

See Also: gsDeleteRow

Since: 5.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowByString	(	GSContainer *	container,
		const GSChar *	key,
		GSBool *	exists
	)

STRING型のロウキーに対応するロウを削除します。

: ロウキーに対応するSTRING型のカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するSTRING型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして指定された場合

See Also: gsDeleteRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowByTimestamp	(	GSContainer *	container,
		GSTimestamp	key,
		GSBool *	exists
	)

通常精度のTIMESTAMP型のロウキーに対応するロウを削除します。

: ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。対応するロウが存在しない場合は何も変更しません。

: ただし、コンテナの種別ならびに設定によっては、制限が設けられています。圧縮オプションが設定された状態の時系列に対しては使用できません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして指定された場合

See Also: gsDeleteRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsDeleteRowGeneral	(	GSContainer *	container,
		GSRowKey *	keyObj,
		GSBool *	exists
	)

指定のロウキーに対応するロウを削除します。

: ロウキーを持つコンテナであれば、ロウキーを構成するカラム数やカラム型によらず使用できます。対応するロウが存在しない場合は何も変更しません。

: ただし、コンテナの種別ならびに設定によっては、制限が設けられています。圧縮オプションが設定された状態の時系列に対しては使用できません。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	keyObj	処理対象のロウキー
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして指定された場合
exists以外の引数にNULLが指定された場合。また、keyに対応する文字列キーのポインタ値がNULLの場合

Since: 4.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsDropIndex	(	GSContainer *	container,
		const GSChar *	columnName,
		GSIndexTypeFlags	flags
	)

指定された名前のカラムのうち、指定された種別の索引のみを削除します。

: カラム名と種別のみが設定されたGSIndexInfoを指定してgsDropIndexDetailを呼び出した場合と同様に振る舞います。ただし、flagsにデフォルト種別を含め一つも種別が指定されていない場合、いずれの索引も削除対象にはなりません。

Parameters

[in]	container	処理対象のGSContainer
[in]	columnName	処理対象のカラムの名前
[in]	flags	削除する索引種別のフラグ値のビット和。指定できる値はgsDropIndexDetailの場合と同様です

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

指定のカラム名と種別がgsDropIndexDetailの規則に合致しない場合
この処理のタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
flags以外の引数にNULLが指定された場合

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult gsDropIndexDetail	(	GSContainer *	container,
		const GSIndexInfo *	info
	)

GSIndexInfoで設定されている内容に一致する、すべての索引を削除します。

: GSIndexInfoの設定内容は、削除対象の索引を絞り込む条件として使用されます。絞り込み条件は、カラム列、索引種別、索引名の3つに分類されます。それぞれ設定するかどうかは任意です。いずれも設定されていない場合は、作成済みのすべての索引が削除されます。

: カラム名列またはカラム番号列が設定されている場合、対応するコンテナにおいて実在するものである必要があります。カラム名列とカラム番号列が共に設定されている場合、対応するカラムが互いに一致している必要があります。カラム名列ならびにカラム番号列が共に設定されていない場合、他の絞り込み条件(索引種別、索引名)を満たす任意のカラム列に対する索引が削除対象となります。

: 索引種別が設定されている場合、指定の種別の索引のみが削除対象となります。GS_INDEX_FLAG_DEFAULTが設定されている場合、gsCreateIndexDetailの基準に従い、デフォルト種別の索引が選択されます。それ以外の場合、対象のカラムにおいて許されている索引種別である限り、任意個数の種別を指定できます。複数個の種別が設定されていた場合、削除途中に一部の索引のみが削除された状態のコンテナ情報を参照できることや、エラーが生じるとその状態まま削除操作が終了することがあります。索引をサポートしていないカラムや指定の種別の索引をサポートしていないカラムについては、削除対象にはなりません。索引種別が設定されていない場合、他の絞り込み条件(カラム列、索引名)を満たす任意の種別の索引が削除対象となります。

: 索引名が設定されている場合、指定の名前の索引のみが削除対象となります。索引名の同一性は、gsCreateIndexDetailの基準に従います。索引名が設定されていない場合、他の絞り込み条件(カラム列、索引種別)を満たす、任意の名前の索引ならびに名前のない索引が削除対象となります。

: 削除対象となる索引が一つも存在しない場合、索引の削除は行われません。

: トランザクションの扱いは、gsCreateIndexDetailと同様です。また、索引種別としてデフォルト種別または単一の種別が設定されており、かつ、複数の索引が削除対象となった場合に、一部の索引のみが削除された状態で他のトランザクションが実行されることがありうるかどうかは未定義です。

: 索引の削除要求の完了直後の状態に関しては、gsDropContainerと同様です。

Parameters

[in]	container	処理対象のGSContainer
[in]	info	処理対象の索引の情報

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

削除対象のカラム、索引名が上記の規則に合致しない場合
この処理のタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
引数にNULLが指定された場合

Since: 3.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsDropTrigger	(	GSContainer *	container,
		const GSChar *	name
	)

トリガを削除します。

: 指定された名前のトリガが存在しない場合は何も削除しません。

Parameters

[in]	container	削除対象のGSContainer
[in]	name	削除対象のトリガ名

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

この処理のタイムアウト、指定のコンテナの削除、接続障害が発生した場合
引数にNULLが指定された場合

Since: 1.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsFlush ( GSContainer * container )

これまでの更新結果をSSDなどの不揮発性記憶媒体に書き出し、すべてのクラスタノードが突然停止したとしても内容が失われないようにします。

: 通常より信頼性が要求される処理のために使用します。ただし、頻繁に実行すると性能低下を引き起こす可能性が高まります。

: 書き出し対象のクラスタノードの範囲など、挙動の詳細はGridDB上の設定によって変化します。

Parameters

[in] container 処理対象のGSContainer

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

この処理のタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetContainerType	(	GSContainer *	container,
		GSContainerType *	type
	)

指定のコンテナの種別を取得します。

: 現バージョンでは、インスタンス生成時点で常に種別が確定するため、この操作によりGridDBクラスタに問い合わせを行うことはありません。

Parameters

[in]	container	処理対象のGSContainer
[out]	type	指定のコンテナの種別を格納するための変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_CONTAINER_COLLECTIONが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

引数にNULLが指定された場合

Since: 1.5

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRow	(	GSContainer *	container,
		const void *	key,
		void *	rowObj,
		GSBool *	exists
	)

ロウキーに対応するロウの内容を取得します。

: ロウキーに対応するカラムが存在する場合のみ使用できます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。同様に、ロウキーの型が一致しない場合の動作も未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in] container 処理対象のGSContainer

[in]

key

処理対象のロウキーが格納された変数へのポインタ値。GSContainerにおいて定義されているコンテナ上のロウキーの型とこの引数の型との関係は次のようになります。

コンテナ上の型	引数の型
STRING	GSChar** ※GSCharとの取り違えに注意*
INTEGER	int32_t*
LONG	int64_t*
TIMESTAMP	GSTimeStamp*
複合ロウキー	GSRowKey*

[out] rowObj 取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。

[out] exists 処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値がNULLの場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByInteger	(	GSContainer *	container,
		int32_t	key,
		void *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

INTEGER型のロウキーに対応するロウの内容を取得します。

: ロウキーに対応するINTEGER型のカラムが存在する場合のみ使用できます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するINTEGER型のカラムが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByLong	(	GSContainer *	container,
		int64_t	key,
		void *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

LONG型のロウキーに対応するロウの内容を取得します。

: ロウキーに対応するLONG型のカラムが存在する場合のみ使用できます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するLONG型のカラムが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByPreciseTimestamp	(	GSContainer *	container,
		const GSPreciseTimestamp *	key,
		void *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

高精度のTIMESTAMP型のロウキーに対応するロウの内容を取得します。

: ロウキーに対応する高精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する高精度のTIMESTAMP型のカラムが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

Since: 5.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByString	(	GSContainer *	container,
		const GSChar *	key,
		void *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

STRING型のロウキーに対応するロウの内容を取得します。

: ロウキーに対応するSTRING型のカラムが存在する場合のみ使用できます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するSTRING型のカラムが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByTimestamp	(	GSContainer *	container,
		GSTimestamp	key,
		void *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

通常精度のTIMESTAMP型のロウキーに対応するロウの内容を取得します。

: ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowForUpdate	(	GSContainer *	container,
		const void *	key,
		void *	rowObj,
		GSBool *	exists
	)

ロウキーに対応するロウについて、更新用ロックを獲得し内容を取得します。

: ロウキーに対応するカラムが存在する場合、かつ、手動コミットモードの場合のみ使用できます。

: トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 取得結果のロウオブジェクトに含まれる文字列や配列などの可変長サイズのデータのリソースは、指定のGSContainerを直接介した次回のロウオブジェクト取得処理を実行するまで維持されます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。同様に、ロウキーの型が一致しない場合の動作も未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。; 文字列や配列などの可変長のデータを格納するために、指定のGSContainerと対応するGSGridStoreインスタンス上で管理される、一時的なメモリ領域を使用します。この領域は、対応するGSGridStoreもしくはその関連リソースに対し、この関数もしくは同様に一時的なメモリ領域を使用する関数が再び実行されるまで有効です。無効になった領域にアクセスしようとした場合の動作は未定義です。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキーが格納された変数へのポインタ値。GSContainerにおいて定義されているコンテナ上のロウキーの型とこの引数の型との関係は、gsGetRowの場合と同様です。
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しない場合
自動コミットモードの場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowGeneral	(	GSContainer *	container,
		GSRowKey *	keyObj,
		GSRow *	rowObj,
		GSBool	forUpdate,
		GSBool *	exists
	)

指定のGSRowKeyに対応するロウの内容をGSRowとして取得します。

: ロウキーを持つコンテナであれば、ロウキーを構成するカラム数やカラム型によらず使用できます。gsGetRowとは異なり、指定のGSRowがクローズされるまで各フィールド値にアクセスすることができます。

: 手動コミットモードにおいて更新用ロックを要求した場合、トランザクションが終了するかタイムアウトするまで対象ロウのロックを維持します。ロックされたロウに対する他のトランザクションからの更新・削除操作は、このトランザクションが終了するかタイムアウトするまで待機するようになります。対象ロウが削除されたとしても、ロックは維持されます。

: 自動コミットモードの場合、更新用ロックを要求できません。

Parameters

[in]	container	処理対象のGSContainer
[in]	keyObj	処理対象のロウキー
[out]	rowObj	取得対象のロウの内容を格納するためのロウオブジェクト。取得対象のロウが存在しない場合、ロウオブジェクトの内容は何も変更されません。実行結果としてGS_RESULT_OK以外が返される場合、ロウオブジェクトのフィールドのうち一部またはすべてが変更されることがあります。
[in]	forUpdate	更新用ロックを要求するかどうか
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーが存在しない場合
自動コミットモードであるにもかかわらず、更新用ロックを要求しようとした場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーとして設定されていた場合
exists以外の引数にNULLが指定された場合

See Also: gsGetRow

Since: 4.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutMultipleRows	(	GSContainer *	container,
		const void const	rowObjs,
		size_t	rowCount,
		GSBool *	exists
	)

指定のロウオブジェクト集合に基づき、任意個数のロウをまとめて新規作成または更新します。

: 指定のロウオブジェクト集合の各ロウについて、配列要素の順序にしたがってgsPutRowを呼び出した場合と同様に新規作成または更新操作を行います。

: 指定のロウオブジェクト集合内に同一のロウキーを持つ複数のロウが存在する場合、ロウオブジェクト集合を構成する配列要素の順序を基準として、同一のロウキーを持つ最も後方にあるロウオブジェクトの内容が反映されます。

: コンテナの種別ならびに設定によっては、操作できるロウの内容についてgsPutRowと同様の制限が設けられています。具体的な制限事項は、個別のコンテナ種別の定義を参照してください。

: 手動コミットモードの場合、対象のロウがロックされます。

: 自動コミットモードのときに、コンテナならびにロウに対する処理の途中でエラーが発生した場合、コンテナの一部のロウに対する操作結果のみが反映されたままとなることがあります。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。同様に、ロウキーの型が一致しない場合の動作も未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	rowObjs	新規作成するロウ集合の内容と対応するロウオブジェクト列。このロウオブジェクト列は、個々のロウオブジェクトへのポインタ値の配列により構成されます。`rowCount`が`0`の場合、この配列を参照することはなく、`NULL`を指定することもできます。
[in]	rowCount	新規作成するロウの個数。`0`の場合、ロウを新規作成せず正常に処理を終えます。
[out]	exists	現バージョンでは、ポインタ値が`NULL`ではない限り常にGS_FALSEが格納されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

特定コンテナ種別固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がロウオブジェクトに含まれていた場合
containerがNULLの場合
exists以外のポインタ型引数にNULLが指定された場合。また、指定のロウオブジェクト内のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合
rowCountが正の値であるにもかかわらず、rowObjsにNULLが指定された場合
ロウオブジェクト列を構成する配列要素にNULLが含まれていた場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRow	(	GSContainer *	container,
		const void *	key,
		const void *	rowObj,
		GSBool *	exists
	)

必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応するカラムが存在する場合、ロウキーとコンテナの状態を基に、ロウを新規作成するか、更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクトとは別にロウキーを指定した場合、ロウオブジェクト内のロウキーより優先して使用されます。

: ロウキーに対応するカラムを持たない場合、常に新規のロウを作成します。別途指定するロウキーには、常にNULLを指定します。

ただし、コンテナの種別ならびに設定によっては、制限が設けられています。指定のコンテナが時系列であり、圧縮オプションが設定されている場合、以下の操作のみを条件付きで行うことができます。

新規作成
- 最も新しい時刻を持つ既存ロウより新しい時刻のロウを指定した場合のみ
既存ロウの内容の保持
- 最も新しい時刻を持つ既存ロウの時刻が指定の時刻と一致する場合のみ

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。同様に、ロウキーの型が一致しない場合の動作も未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキーが格納された変数へのポインタ値。GSContainerにおいて定義されているコンテナ上のロウキーの型とこの引数の型との関係は、gsGetRowの場合と同様です。ロウキーに対応するカラムが存在しない場合、もしくは指定のロウオブジェクト内のキーを用いる場合は`NULL`を指定します。
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しないにもかかわらず、キーが指定された場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のロウキー以外のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合。もしくは、ロウキーに対応するカラムが存在しkeyがNULLであるにもかかわらず、ロウキーのフィールドに同様にNULLが含まれていた場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowByInteger	(	GSContainer *	container,
		int32_t	key,
		const void *	rowObj,
		GSBool *	exists
	)

INTEGER型のロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応するINTEGER型のカラムが存在する場合のみ使用できます。

: ロウキーとコンテナの状態を基に、ロウを新規作成するか更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクト内のロウキーは無視されます。

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するINTEGER型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のロウキー以外のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合。もしくは、ロウキーに対応するカラムが存在しkeyがNULLであるにもかかわらず、ロウキーのフィールドに同様にNULLが含まれていた場合

See Also: gsPutRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowByLong	(	GSContainer *	container,
		int64_t	key,
		const void *	rowObj,
		GSBool *	exists
	)

LONG型のロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応するLONG型のカラムが存在する場合のみ使用できます。

: ロウキーとコンテナの状態を基に、ロウを新規作成するか更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクト内のロウキーは無視されます。

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するLONG型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のロウキー以外のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合。もしくは、ロウキーに対応するカラムが存在しkeyがNULLであるにもかかわらず、ロウキーのフィールドに同様にNULLが含まれていた場合

See Also: gsPutRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowByPreciseTimestamp	(	GSContainer *	container,
		const GSPreciseTimestamp *	key,
		const void *	rowObj,
		GSBool *	exists
	)

高精度のTIMESTAMP型のロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応する高精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。

: ロウキーとコンテナの状態を基に、ロウを新規作成するか更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクト内のロウキーは無視されます。

新規作成
- 最も新しい時刻を持つ既存ロウより新しい時刻のロウを指定した場合のみ
既存ロウの内容の保持
- 最も新しい時刻を持つ既存ロウの時刻が指定の時刻と一致する場合のみ

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する高精度のTIMESTAMP型のカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合

See Also: gsPutRow

Since: 5.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowByString	(	GSContainer *	container,
		const GSChar *	key,
		const void *	rowObj,
		GSBool *	exists
	)

STRING型のロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応するSTRING型のカラムが存在する場合のみ使用できます。

: ロウキーとコンテナの状態を基に、ロウを新規作成するか更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクト内のロウキーは無視されます。

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するSTRING型のカラムが存在しない場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のロウキー以外のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合

See Also: gsPutRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowByTimestamp	(	GSContainer *	container,
		GSTimestamp	key,
		const void *	rowObj,
		GSBool *	exists
	)

通常精度のTIMESTAMP型のロウキーを指定して、ロウを新規作成または更新します。

: ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在する場合のみ使用できます。

: ロウキーとコンテナの状態を基に、ロウを新規作成するか更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクト内のロウキーは無視されます。

新規作成
- 最も新しい時刻を持つ既存ロウより新しい時刻のロウを指定した場合のみ
既存ロウの内容の保持
- 最も新しい時刻を持つ既存ロウの時刻が指定の時刻と一致する場合のみ

: 手動コミットモードの場合、対象のロウはロックされます。

Attention: 指定のGSContainerにバインドされたロウオブジェクトの型と指定のロウオブジェクトの型とが一致しない場合、この処理の動作は未定義です。アクセス違反により実行プロセスが異常終了する可能性があります。

Parameters

[in]	container	処理対象のGSContainer
[in]	key	処理対象のロウキー
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応する通常精度のTIMESTAMP型のカラムが存在しない場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合

See Also: gsPutRow

GS_DLL_PUBLIC GSResult GS_API_CALL gsPutRowGeneral	(	GSContainer *	container,
		GSRowKey *	keyObj,
		GSRow *	rowObj,
		GSBool *	exists
	)

必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。

: ロウキーを構成するカラム数やカラム型によらず使用できます。

: ロウキーに対応するカラムが存在する場合、ロウキーとコンテナの状態を基に、ロウを新規作成するか、更新するかを決定します。この際、対応するロウがコンテナ内に存在しない場合は新規作成、存在する場合は更新します。ロウオブジェクトとは別にロウキーを指定した場合、ロウオブジェクト内のロウキーより優先して使用されます。

: ロウキーに対応するカラムを持たない場合、常に新規のロウを作成します。この場合、別途指定するロウキーには、常にNULLを指定します。

: ただし、コンテナの種別ならびに設定によっては、gsPutRowと同様の制限が設けられています。

: 手動コミットモードの場合、対象のロウはロックされます。

Parameters

[in]	container	処理対象のGSContainer
[in]	keyObj	処理対象のロウキー。ロウキーに対応するカラムが存在しない場合、もしくは指定のロウオブジェクト内のキーを用いる場合は`NULL`を指定します。
[in]	rowObj	新規作成または更新するロウの内容と対応するロウオブジェクト
[out]	exists	処理対象のロウが存在したかどうかを格納するためのブール型変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、GS_FALSEが格納されます。ポインタ値が`NULL`の場合、この格納処理が省略されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

ロウキーに対応するカラムが存在しないにもかかわらず、キーが指定された場合
特定コンテナ固有の制限に反する操作を行った場合
この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
サポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
exists以外の引数にNULLが指定された場合。また、指定のロウオブジェクト内のロウキー以外のフィールドについて、文字列など可変長サイズのデータへのポインタ値にNULLが含まれていた場合。もしくは、ロウキーに対応するカラムが存在しkeyがNULLであるにもかかわらず、ロウキーのフィールドに同様にNULLが含まれていた場合

See Also: gsPutRow

Since: 4.3

GS_DLL_PUBLIC GSResult GS_API_CALL gsQuery	(	GSContainer *	container,
		const GSChar *	queryString,
		GSQuery **	query
	)

指定のTQL文を実行するためのクエリを作成します。

: gsFetchを通じてロウ集合を求める際に更新用ロックのオプションを有効できるのは、指定のコンテナ上に実在しないロウが選択されることのないクエリのみです。たとえば、補間演算を含むクエリに対しては有効にできません。

Parameters

[in]	container	処理対象のGSContainer
[in]	queryString	TQL文
[out]	query	GSQueryインスタンスを格納するためのポインタ変数へのポインタ値。実行結果としてGS_RESULT_OK以外が返される場合、このポインタ値が`NULL`以外の値であれば、対応するポインタ変数に`NULL`が格納されます。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

引数にNULLが指定された場合

GS_DLL_PUBLIC GSResult GS_API_CALL gsSetAutoCommit	(	GSContainer *	container,
		GSBool	enabled
	)

コミットモードの設定を変更します。

: 自動コミットモードでは、直接トランザクション状態を制御できず、変更操作が逐次コミットされます。自動コミットモードが有効でない場合、すなわち手動コミットモードの場合は、直接gsCommitを呼び出すかトランザクションがタイムアウトしない限り、指定のコンテナ内で同一のトランザクションが使用され続け、変更操作はコミットされません。

: 自動コミットモードが無効から有効に切り替わる際、未コミットの変更内容は暗黙的にコミットされます。コミットモードに変更がない場合、トランザクション状態は変更されません。

Parameters

[in]	container	処理対象のGSContainer
[in]	enabled	自動コミットモードを有効にするかどうか。GS_TRUEの場合は自動コミットモード、GS_FALSEの場合は手動コミットモードが有効になります。

Returns

実行結果のコード番号。次の場合、GS_RESULT_OK以外の値を返します。

モード変更に伴いコミット処理を要求した際に、この処理またはトランザクションのタイムアウト、指定のコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
ポインタ型引数にNULLが指定された場合

Classes GSGridStore
struct	GSContainerRowEntryTag
	複数のコンテナの複数のロウを一括して操作する場合に用いる、コンテナ別のロウ内容エントリです。More...

struct	GSRowKeyPredicateEntryTag
	複数のコンテナに対する取得条件を表すための、コンテナ別の合致条件エントリです。More...

Macros GSGridStore
#define	GS_CONTAINER_ROW_ENTRY_INITIALIZER { NULL, NULL, 0 }
	GSContainerRowEntryの初期化子です。More...

#define	GS_ROW_KEY_PREDICATE_ENTRY_INITIALIZER { NULL, NULL }
	GSRowKeyPredicateEntryの初期化子です。More...

Typedefs GSGridStore
typedef struct GSGridStoreTag	GSGridStore
	1つのGridDBシステムが管理するデータ全体を操作するための機能を提供します。More...

typedef struct GSContainerRowEntryTag	GSContainerRowEntry
	複数のコンテナの複数のロウを一括して操作する場合に用いる、コンテナ別のロウ内容エントリです。More...

typedef struct GSRowKeyPredicateEntryTag	GSRowKeyPredicateEntry
	複数のコンテナに対する取得条件を表すための、コンテナ別の合致条件エントリです。More...

Functions GSGridStore
GS_DLL_PUBLIC void GS_API_CALL	gsCloseGridStore (GSGridStore **store, GSBool allRelated)
	指定のGSGridStoreインスタンスについて、対応するGridDBクラスタとの接続状態を解除し、必要に応じて指定のインスタンスならびに関連するリソースを解放します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDropCollection (GSGridStore store, const GSChar name)
	指定の名前を持つコレクションを削除します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDropTimeSeries (GSGridStore store, const GSChar name)
	指定の名前を持つ時系列を削除します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsGetCollection (GSGridStore store, const GSChar name, const GSBinding binding, GSCollection *collection)
	指定の名前のコレクションを操作するためのGSCollectionインスタンスを取得します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsGetContainerInfo (GSGridStore store, const GSChar name, GSContainerInfo info, GSBool exists)
	指定の名前のコンテナに関する情報を取得します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsGetTimeSeries (GSGridStore store, const GSChar name, const GSBinding binding, GSTimeSeries *timeSeries)
	指定の名前の時系列を操作するためのGSTimeSeriesインスタンスを取得します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutContainer (GSGridStore store, const GSChar name, const GSBinding binding, const GSContainerInfo info, GSBool modifiable, GSContainer **container)
	バインディング情報とGSContainerInfoを指定して、コンテナを新規作成または変更します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutCollection (GSGridStore store, const GSChar name, const GSBinding binding, const GSCollectionProperties properties, GSBool modifiable, GSCollection **collection)
	コレクションを新規作成または変更します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutTimeSeries (GSGridStore store, const GSChar name, const GSBinding binding, const GSTimeSeriesProperties properties, GSBool modifiable, GSTimeSeries **timeSeries)
	時系列を新規作成または変更します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutContainerGeneral (GSGridStore store, const GSChar name, const GSContainerInfo info, GSBool modifiable, GSContainer *container)
	GSContainerInfoを指定して、コンテナを新規作成または変更します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetContainerGeneral (GSGridStore store, const GSChar name, GSContainer **container)
	GSRowによりロウ操作できるGSContainerインスタンスを取得します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutCollectionGeneral (GSGridStore store, const GSChar name, const GSContainerInfo info, GSBool modifiable, GSCollection *collection)
	GSContainerInfoを指定して、コレクションを新規作成または変更します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetCollectionGeneral (GSGridStore store, const GSChar name, GSCollection **collection)
	GSRowによりロウ操作できるGSCollectionインスタンスを取得します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsPutTimeSeriesGeneral (GSGridStore store, const GSChar name, const GSContainerInfo info, GSBool modifiable, GSTimeSeries *timeSeries)
	GSContainerInfoを指定して、時系列を新規作成または変更します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetTimeSeriesGeneral (GSGridStore store, const GSChar name, GSTimeSeries **timeSeries)
	GSRowによりロウ操作できるGSTimeSeriesインスタンスを取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsDropContainer (GSGridStore store, const GSChar name)
	指定の名前を持つコンテナを削除します。More...

GS_STATIC_HEADER_FUNC_SPECIFIER GSResult	gsCreateRowByStore (GSGridStore store, const GSContainerInfo info, GSRow **row)
	GSContainerInfoを指定して、GSRowを新規作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateRowKeyByStore (GSGridStore store, const GSContainerInfo info, GSRowKey **key)
	GSContainerInfoを指定して、GSRowKeyを新規作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsFetchAll (GSGridStore store, GSQuery const *queryList, size_t queryCount)
	指定された任意個数のGSQueryについて、可能な限りリクエスト単位を大きくしてクエリ実行とフェッチを行います。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsPutMultipleContainerRows (GSGridStore store, const GSContainerRowEntry entryList, size_t entryCount)
	任意のコンテナの任意個数のロウについて、可能な限りリクエスト単位を大きくして新規作成または更新操作を行います。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetMultipleContainerRows (GSGridStore store, const GSRowKeyPredicateEntry const predicateList, size_t predicateCount, const GSContainerRowEntry entryList, size_t entryCount)
	指定の条件に基づき、任意のコンテナの任意個数・範囲のロウについて、可能な限りリクエスト単位を大きくして取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsGetPartitionController (GSGridStore store, GSPartitionController *partitionController)
	対応するGridDBクラスタについてのGSPartitionControllerを取得します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateRowKeyPredicate (GSGridStore store, GSType keyType, GSRowKeyPredicate *predicate)
	指定のGSTypeをロウキーの型とする合致条件を作成します。More...

GS_DLL_PUBLIC GSResult GS_API_CALL	gsCreateRowKeyPredicateGeneral (GSGridStore store, const GSContainerInfo info, GSRowKeyPredicate **predicate)
	指定のGSContainerInfoのロウキーに関するカラム定義に基づく、合致条件を作成します。More...

Detailed Description

Macro Definition Documentation

#define GS_CONTAINER_ROW_ENTRY_INITIALIZER { NULL, NULL, 0 }

GSContainerRowEntryの初期化子です。

Since: 1.5

#define GS_ROW_KEY_PREDICATE_ENTRY_INITIALIZER { NULL, NULL }

GSRowKeyPredicateEntryの初期化子です。

Since: 1.5

Typedef Documentation

typedef struct GSContainerRowEntryTag GSContainerRowEntry

複数のコンテナの複数のロウを一括して操作する場合に用いる、コンテナ別のロウ内容エントリです。

Since: 1.5

typedef struct GSGridStoreTag GSGridStore

1つのGridDBシステムが管理するデータ全体を操作するための機能を提供します。

: コレクションや時系列といったコンテナの追加・削除・構成変更、ならびに、コンテナを構成するロウの操作機能を提供します。

: コンテナ種別などの違いによらず、1つのデータベースのコンテナ間で、ASCIIの大文字・小文字表記だけが異なる名前のものを複数定義することはできません。コンテナ名は、ベースコンテナ名単独、もしくは、ベースコンテナ名の後ろにノードアフィニティ名をアットマーク「@」で連結した形式で表記します。その他、コンテナの定義において使用できるコンテナ名の文字種や長さには制限があります。具体的には、GridDB機能リファレンスを参照してください。特に記載のない限り、コンテナ名を指定する操作では、ASCIIの大文字・小文字表記の違いは区別されません。

このインタフェースまたはこのインタフェースを通じて得られたインスタンスのインタフェースに対する操作を通じてエラーが発生した場合、エラーに関する次のパラメータを取得できることがあります。

パラメータ名

説明

address

接続先クラスタノードのアドレス・ポート。ホスト名またはIPアドレスとポート番号とをコロン「:」で連結した文字列により構成されます。このインタフェースまたはこのインタフェースを通じて得られたインスタンスのインタフェースにおいて、クラスタへのアクセスを伴う操作を呼び出した際にエラーを検知すると、このパラメータを含むことがあります。このパラメータを含む場合、パラメータが示すクラスタノードにおいてエラーの詳細が記録されていることがあります。

container

エラーに関係しうるコンテナの名前。任意個数のコンテナを一括して扱う操作において、そのうち少なくとも一つのコンテナについての操作を行えないことが判明した場合に、このパラメータを含むことがあります。任意個数のコンテナを扱う具体的な操作については、個々のインタフェースの定義を参照してください。クラスタノードへのリクエスト準備段階でのリソース不足など、どのコンテナの問題か特定し切れないことがあるため、どのようなエラーでもこのパラメータを含むとは限りません。また、複数のコンテナについて操作できない可能性があったとしても、パラメータに含まれるのは高々一つのコンテナの名前のみです。

: この型のポインタを第一引数とする関数のスレッド安全性は保証されません。

See Also: GSCollection; GSTimeSeries; GSContainer; gsGetErrorParameterCount

typedef struct GSRowKeyPredicateEntryTag GSRowKeyPredicateEntry

複数のコンテナに対する取得条件を表すための、コンテナ別の合致条件エントリです。

Since: 1.5

Function Documentation