GridDB C APIリファレンス

GSContainerRowEntryの初期化子です。

Since

1.5

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

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

Parameters

type

対応関係の定義名。

Returns

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

See Also

GS_STRUCT_BINDING

GSIndexInfoの初期化子です。

Since

3.5

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

See Also

GSResult

GSRowKeyPredicateEntryの初期化子です。

Since

1.5

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

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

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

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

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

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

Parameters

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

See Also

GS_STRUCT_BINDING

Since

4.3

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

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

Parameters

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

See Also

GS_STRUCT_BINDING

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

See Also

GS_RESULT_OK

GSResult

GSTimeSeriesPropertiesの初期化子です。

ロウの有効期限ならびに圧縮ロウの間引き連続制限は無効、時系列圧縮方式は無圧縮に設定されます。

See Also

GSAggregationTag

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

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

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

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

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

Note

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

特定のカラムの圧縮設定を表します。

時系列を対象とした誤差あり間引き圧縮のカラム別設定に使用します。

See Also

GSCompressionMethodTag

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

Since

1.5

See Also

GSContainerTypeTag

See Also

GSFetchOptionTag

See Also

GSGeometryOperatorTag

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

Since

3.5

See Also

GSIndexTypeFlagTag

See Also

GSInterpolationModeTag

クエリプランならびにクエリ処理解析結果を構成する一連の情報の一つを示します。

TQLのEXPLAIN文ならびEXPLAIN ANALYZE文の実行結果を保持するために使用します。1つの実行結果は、このエントリの列により表現されます。

See Also

GSQueryOrderTag

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

Since

1.5

See Also

GSRowSetTypeTag

See Also

GSTimeOperatorTag

時系列を新規作成または変更する際に使用される、オプションの構成情報を表します。

カラム名の表記、もしくは、個別に圧縮設定できるカラム数の上限などの内容の妥当性について、必ずしも検査するとは限りません。

See Also

GSTimeUnitTag

See Also

GSTriggerEventTypeFlagTag

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

Since

1.5

See Also

GSTriggerTypeTag

See Also

GSTypeTag

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

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

設定項目	フラグ値
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

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

Since

1.5

ロウ集合またはその特定のカラムに対する、集計演算の方法を示します。

現バージョンでは、GSTimeSeriesに対してのみ使用できます。

重み付きの演算の場合、キーの値に基づき重み付け値を決定します。GSTimeSeriesに対する重み付きの演算の場合、前後それぞれの時刻のロウとの中間時刻間の期間を特定の単位で換算したものを、重み付け値として使用します。ただし、前後いずれかの時刻のロウのみが存在しない場合は、存在しないロウの代わりに重み付け対象のロウを用いて求めた重み付け値を使用します。前後いずれの時刻のロウも存在しない場合は、重み付け値として1 (単位は前後いずれかのロウが存在する場合と同一)を使用します。

演算の内部処理にてオーバーフローが発生した場合、浮動小数点数型では負または正の無限大、整数型では未定義の値が求まります。また、浮動小数点数型にて演算対象に非数(NaN)が含まれていた場合、非数が求まります。

圧縮方式の種別を表します。

時系列圧縮設定を行う際に使用します。

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

クエリ実行結果を取得する際のオプション項目です。

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

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

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

ロウの補間方法の種別を表します。

時系列ロウの補間機能で使用されます。

クエリにおける要求ロウ順序を表します。

各種クエリ機能別に定義される判定対象を基準として、順序指定を行うために使用します。具体的な判定対象は、個別の機能によって異なります。

GSRowSetから取り出すことのできる内容の種別です。

GSTimeSeriesのキー時刻に基づく、ロウの特定方法を表します。

別途指定する時刻と組み合わせることで、最も近い時刻のキーを持つロウなどを特定できます。該当するロウが存在しない場合の扱いは、この列挙型を使用するそれぞれの機能により異なります。

時系列処理で用いる時間の単位を示します。

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

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

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

See Also

GSTypeOption

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

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

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

数値型の集計値を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

数値型の集計値を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

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

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

Parameters

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

Returns

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

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

Since

3.5

指定のフィールドにNULLが設定されているかどうかを返します。

NOT NULL制約の設定されたカラムが指定された場合、常にGS_FALSEを返します。

Parameters

[in]	row	処理対象のGSRow
[in]	column	対象フィールドのカラム番号。0以上かつカラム数未満の値
[out]	nullValue	NULLが設定されているかどうか受け取る変数へのポインタ値

Returns

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

• ポインタ型引数にNULLが指定された場合
• 範囲外のカラム番号が指定された場合

Since

3.5

指定のフィールドにNULLを設定します。

Parameters

[in]	row	処理対象のGSRow
[in]	column	対象フィールドのカラム番号。0以上かつカラム数未満の値

Returns

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

• ポインタ型引数にNULLが指定された場合
• 範囲外のカラム番号が指定された場合
• NOT NULL制約の設定されたカラムが指定された場合

Since

3.5

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

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

Parameters

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

Returns

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

Since

4.2

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

Since

4.2

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

Parameters

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

Returns

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

See Also

gsGetErrorParameterCount

Since

4.2

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

Parameters

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

Returns

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

See Also

gsGetErrorParameterCount

Since

4.2

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

Parameters

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

Returns

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

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

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

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

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

Parameters

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

Returns

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

Since

4.2

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

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

Parameters

[in]

gsResource

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

Returns

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

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

Returns

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

Since

1.5

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

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

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

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

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

Parameters

[in,out]

aggregationResult

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

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

取り出しできる型は、指定の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が指定された場合

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

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

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

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

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

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

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

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

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が指定された場合

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

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が指定された場合