GridDB APIリファレンス

Revision: 1618

Table of Contents

1 はじめに

このマニュアルでは、分散大容量DB、GridDBプログラミングに必要となる、APIやクエリ言語の使用方法を説明します。

GridDBにおける管理操作や基本的なデータ取り出しには、JavaまたはC言語によるAPIを使用します。より複雑な条件を記述する場合は、専用のクエリ言語TQLを使用します。

※次の機能はStandard/Advanced/Vector Editionでのみ提供されます

  • 空間データ型および空間索引
  • 時系列コンテナデータ圧縮機能

2 概要

2.1 用語

主な用語を説明します。

  • ノード
    • GridDBでデータ管理を行う個々のサーバプロセスを指します。
  • ロウ
    • GridDBで管理する1件分のデータを指します。1つ以上の値を持つひとまとまりのデータです。
  • コンテナ
    • ロウの集合を管理する入れ物です。コレクションと時系列の2種類が存在します。
    • ロウはカラムごとに1つのフィールドを持ちます。それぞれのフィールドは常に1つの値を持ちます。フィールドの値としてNULLを設定することができます。
    • コンテナ名ならびにカラム名は、1文字以上のASCII英数字ならびにアンダースコア「_」の列で構成されます。ただし、先頭の文字には数字を指定できません。また、大文字・小文字は区別されません。
  • コレクション
    • ロウを管理するコンテナの一種です。ロウに対しキーを持たせることも、持たせないこともできます。キーとして使用できる型は単一の文字列(STRING)型、INTEGER型、LONG型、または時刻(TIMESTAMP)型です。キーにはNULLを設定できません。
  • 時系列
    • 時刻(TIMESTAMP)型のキーを持つロウを管理するコンテナの一種です。時系列データを扱う専用の機能を持ちます。キーが時系列ロウの時刻に相当します。キーにはNULLを設定できません。

2.2

フィールドならびにクエリ演算で用いる値の制約を示す、型について定義します。

2.2.1 基本型

他の型の組み合わせで表現できない、基本的な型を定義します。

  • ブール(BOOL)型
    真または偽のいずれかの値を表します。
  • 文字列(STRING)型
    Unicodeコードポイントを文字とする、任意個数の文字の列より構成されます。ただし、NULL文字(U+0000)は扱いません。上限サイズについてはGridDBテクニカルリファレンスを参照してください。
  • 整数型
    それぞれ次の範囲の整数値を表します。
    • BYTE型: -27から27-1 (8ビット)
    • SHORT型: -215から215-1 (16ビット)
    • INTEGER型: -231から231-1 (32ビット)
    • LONG型: -263から263-1 (64ビット)
  • 浮動小数点数型
    IEEE754で定められた浮動小数点数を表します。精度に応じた次の型があります。
    • FLOAT型: 単精度型(32ビット)
    • DOUBLE型: 倍精度型(64ビット)

    ※演算精度は原則IEEE754準拠ですが、実行環境により異なる場合があります。

  • 時刻(TIMESTAMP)型
    年月日ならびに時分秒からなる時刻を表します。表現範囲については付録の値の範囲を参照してください。
  • 空間(GEOMETRY)型
    空間構造を表します。上限サイズについてはGridDBテクニカルリファレンスを参照してください。各構造の表す座標の数値として非数(NAN)や正負の無限大(INF、-INF)は扱いません。 また、SRID (Spatial Reference System Identifier)を整数型の値として格納できますが、SRIDの表す座標系による座標の範囲制限や、SRIDの変換による座標変換については対応していません。
  • BLOB型
    画像や音声などのバイナリデータを表します。上限サイズについてはGridDBテクニカルリファレンスを参照してください。

2.2.2 複合型

基本型の組み合わせで構成される型を定義します。

  • 配列型

    値の列を表します。以下の型について配列型を提供します。長さとは、構成される配列要素の数であり、最小値は0となります。長さの上限についてはGridDBテクニカルリファレンスを参照してください。配列の要素にNULLは設定できません。

    • ブール型
    • 文字列型
    • 整数型
    • 浮動小数点数型
    • 時刻型

3 TQL構文・演算機能

TQLでは、データの取り出し・削除・更新対象の選択のために必要となる、SQLのselect文相当のクエリをサポートします。選択したデータの操作、データ構造管理やトランザクション処理といった、選択操作以外の構文は扱いません。

3.1 基本構文

すべてのクエリは、次の構文により表現されます。

[EXPLAIN [ANALYZE]] SELECT (選択式) [FROM (コレクション・時系列名)] [WHERE (条件式)] [ORDER BY (ソート条件)] [LIMIT (数値) [OFFSET (数値)]]

SELECT構文は、FROM節で指定したコレクション・時系列の各ロウについて、WHERE節の条件式に従い絞り込み、その結果を対象カラムや集計方法などが指定された選択式に基づき加工することを要求します。

クエリ実行対象のコレクション・時系列がすでに確定している場合、FROM節を省略するか、対象と同じ名前をFROM節に指定する必要があります。ただし、大文字・小文字は区別されません。WHERE節を省略した場合、対象コレクション・時系列のすべてのロウが選択されます。

SELECT文の前にEXPLAINまたはEXPLAIN ANALYZEを付けた場合、SELECT文に対する実行プラン情報ならびに実行結果の解析情報を求めます。詳細は後述の節を参照してください。

なお、集計演算などを除き、SQLのように特定カラムだけを取り出すことはできません。また、次に相当する節は記述できません。

  • GROUP BY
  • HAVING
  • DISTINCT
  • FOR UPDATE※APIにて指定可能
  • JOIN

これらの基本構文のキーワード、ならびに以降の節で定義する関数や演算子・列挙定数名については、ASCIIコードでの大文字部分を小文字のみで表記することもできます。

3.2 条件式構文・演算機能

WHERE節で使用される条件式の構文、ならびに、条件式で利用可能な演算子や関数を定義します。 演算子や関数にNULLが含まれる場合は特に記載がないかぎり、NULLを返します。

3.2.1

値は、クエリ内で一定のリテラル、または、評価中のロウにおける指定カラムのフィールドのいずれかにより表現します。

  • リテラル値
    次のいずれかのリテラル値を指定します。
    • 数値型: 10進数による文字列表現で記述します。浮動小数点数の表記はIEEE754に従います。なお、DOUBLE型の非数、正の無限大、負の無限大は、それぞれNAN、INF、-INFと表記します
    • 文字列: シングルクォーテーションで囲んだ文字列を指定します。文字列を構成する文字の一つとしてシングルクォーテーションを表記するためには、シングルクォーテーションを二つ続けて記述します。それ以外の用途でシングルクォーテーションを記述することはできません
    • NULL: NULLと記述します。
  • フィールド値
    評価中のロウが持つフィールド値を指定するには、対応するカラム名をそのまま記述するか、引用符「"」で囲んだカラム名を記述します。引用符で囲むことにより、「SELECT」や「WHERE」といったキーワードと同名のカラムについても扱うことができます。カラム名についての大文字・小文字表記の違いは区別されません。また、「.」などを用いてコレクション・時系列の名前と組み合わせることはできません。

3.2.2 演算子の優先順位

演算子は、次の優先順で評価されます。同順序の演算子同士の場合、記述した順序通りに評価されます。

  1. -(単項)
  2. *, /, %
  3. -(二項), +
  4. =, >=, >, <=, <, <>, LIKE, IS, IS NOT
  5. NOT
  6. AND
  7. OR, XOR

なお、式を「(」…「)」で囲むことで、上の演算子よりも優先して該当する式を評価します。

3.2.3 比較演算

  • 型の制約
    両辺の型の組み合わせは、ブール型同士、文字型同士、数値型同士、時刻型同士のいずれかのみです。数値型については、両辺の精度が異なる場合、より表現範囲の大きい型、もしくはより精度の高い型に変換されます。なお、ブール型同士、文字列型同士の場合、大小比較はできません。
  • =, >=, >, <=, <, <>
    それぞれ、等価、以上、大なり、以下、小なり、非等価の比較演算結果をブール型で求めます。但しいずれかの値がNULLの場合NULLを返します。 浮動小数点数の比較結果は基本的にはIEEE754に従いますが、NAN(非数)は他の全ての値より大きいと見なし、 NAN同士は等しいと評価します。
  • IS, IS NOT
    左辺の値がNULLと等価、非等価の比較演算結果をブール型で求めます。右辺はNULLでなければなりません。

3.2.4 論理演算

  • NOT, AND, OR, XOR
    それぞれ、否定、論理積、論理和、排他的論理和を示します。演算対象はブール値またはNULLでなければなりません。
    • NOT
      TRUEならばFALSEを、FALSEならTRUEを、NULLならばNULLを返します。
    • AND
      両辺がTRUEならばTRUEを、いずれかがFALSEならFALSEを、それ以外はNULLを返します。
    • OR
      両辺がFALSEならばFALSEを、いずれかがTRUEならTRUEを、それ以外はNULLを返します。
    • XOR
      両辺がFALSEまたは両辺がTRUEならばFALSEを、いずれかがNULLならNULLを、それ以外はTRUEを返します。

      また、AND, ORの演算では短絡評価(または最小評価)を行います。すなわち、先に記述されている式で評価を確定できる場合、後に記述されている式の評価を行いません。 たとえば、

      WHERE A=1 AND B=1
      

      の場合、Aが1であれば、B=1を評価しますが、Aが1でない場合、B=1の評価は行いません。

3.2.5 文字列演算

  • CHAR_LENGTH(str)
    文字列の長さを求めます。
  • CONCAT(str1, str2, …)
    指定の文字列を順に結合し、1つの文字列を生成します。入力にNULLが含まれる場合はNULLを無視して結合されます
  • str LIKE pattern [ESCAPE esc]
    検査対象の文字列全体が指定のパターンと一致するかどうかを判定します。判定の際、大文字・小文字を区別します。判定により一致した場合のみ真を返します。

    パターン指定では、次のワイルドカード文字を使用できます。

    • %: 0文字以上の任意の文字列と一致
    • _: 1文字の任意の文字と一致

    たとえば、次の式は「山田」「田中」「山田太郎」に対して真を返しますが、「小山田」に対しては偽を返します。

    column LIKE '_田%'
    

    ワイルドカード文字は、パターン内の任意の位置に任意の回数だけ使用できます。 空文字列のパターンを指定した場合、常に偽を返します。

    ワイルドカード文字そのものを検索する場合には、ESCAPE節を使ってエスケープ文字を指定します。 たとえば、以下の式は「10%」に対しては真を返しますが、「10$%」に対しては偽を返します。

    column LIKE '10$%' ESCAPE '$'
    

    エスケープ文字の長さは常に1でなければなりません。

    検査対象の文字列、パターン、エスケープには、カラム名もしくは文字列リテラルのみを指定できます。

  • SUBSTRING(str, start[, length])
    部分文字列を求めます。

    startには1から始まる文字位置、lengthには取り出す文字列の長さを示す0以上の値を指定します。lengthを省略した場合、指定start位置以降のすべての文字を含めます。start、lengthが範囲外の値を指す場合、空文字列を返します。ただし、startに0以下の値、lengthに0未満の値を指定することはできません。

  • UPPER(str), LOWER(str)
    文字列中のASCII相当の英字について、それぞれ大文字または小文字に変換します。

3.2.6 数値演算

  • +, -(単項), -(二項), *, /, %
    算術演算を行います。それぞれ、加算、符号反転、減算、乗算、除算、剰余算を表します。ただし浮動小数点数に対する剰余算は行えません。 浮動小数点数において被除数が0以外の数で除数が0の場合は無限大、被除数と除数が共に0の場合は非数になります。 無限大や非数に関する演算はIEEE754に従います。
  • ROUND(num)、FLOOR(num)、CEILING(num)
    それぞれ、元の浮動小数点数に関して、小数の桁を四捨五入した整数値、より小きな整数値のうち最大のもの、より大きな整数値のうち最小のものを求めます。結果はDOUBLE型となります。 丸めの方向はそれぞれ、0から遠い方、負の無限大に近い方、正の無限大に近い方になります。 したがってnumが負の値の場合の計算結果は、numの絶対値abs(num)を用いると、-ROUND(abs(num))、-CEILING(abs(num))、-FLOOR(abs(num))と等しくなります。

    それぞれの計算例は以下の通りです。

    ROUNDFLOORCEILING
    1.341.01.02.0
    3.674.03.04.0
    -0.230.0-1.0-0.0
    -3.89-4.0-4.0-3.0

    なお、+0.0、-0.0、整数、非数(NAN)、正負の無限大(INF、-INF)に対してこれらの操作を行っても値は変化しません。

3.2.7 時刻型演算

  • NOW()
    現在時刻を返します。同一のクエリ実行単位内では、常に同一の結果を返します。
  • TIMESTAMP(str)
    時刻の文字列表現を時刻型に変換します。

    文字列表現として、西暦、UTCでの次の形式のみをサポートします。

    YYYY-MM-DDThh:mm:ss.SSSZ
    

    「.SSS」の部分は省略できます。 上の形式のうち、英字の部分は10進数表現の整数値で、それぞれ次の意味を示します。

    • YYYY: 年に相当する。最低4桁
    • MM: 月に相当する。常に2桁であり、1から12の範囲で指定する
    • DD: 日に相当する。常に2桁であり、1から31の範囲で指定する。存在しない日を指定した場合、受け付けない。年や月によって異なる
    • hh: 24時間表記での時間に相当する。常に2桁であり、0から23の範囲で指定する
    • mm: 分に相当する。常に2桁であり、0から59の範囲で指定する
    • ss: 秒に相当する。常に2桁であり、0から59の範囲で指定する
    • SSS: ミリ秒に相当する。常に3桁であり、0から999の範囲で指定する

    表現範囲については付録の値の範囲を参照してください。

  • TIMESTAMPADD(YEAR|MONTH|DAY|HOUR|MINUTE|SECOND|MILLISECOND, timestamp, duration)
    指定の時刻に対し、指定した単位の特定の期間を加算します。期間には数値型の値を指定します。負の値の期間を指定した場合は、元の時刻より過去の時刻が求まります。現バージョンでは、算出の際に使用されるタイムゾーンはUTCです。
  • TIMESTAMPDIFF(YEAR|MONTH|DAY|HOUR|MINUTE|SECOND|MILLISECOND, timestamp1, timestamp2)
    2つの時刻の差について、指定した単位で結果を求めます。結果は数値型の値となります。現バージョンでは、算出の際に使用されるタイムゾーンはUTCです。

    例) チケット一覧(tickets)の中から、有効期間が3日以上のチケットを選択する

    SELECT * FROM tickets WHERE TIMESTAMPDIFF(DAY, expired, issued) >= 3
    
  • TO_TIMESTAMP_MS(num)
    時刻1970-01-01T00:00:00Zのnumミリ秒後に対応するTIMESTAMPへ変換します。numが浮動小数点数型の値の場合、エラーになります。また、負の値や極端に大きな値など、変換結果が時刻型で表せない場合はエラーになります。そのため、数値型カラムに対して本関数を用いたクエリを発行した場合、カラムの値に変換結果が時刻型で表せない値が含まれているとエラーになります。例えば、以下のクエリはnum=-1となるロウがコンテナ内にある場合エラーになります。
    SELECT * WHERE TO_TIMESTAMP_MS(num) > TIMESTAMP('2011-01-01T00:00:00Z')
    

    このような場合はTO_EPOCH_MS関数を用いて以下のようにして、数値型の値を変換した結果が時刻型の範囲となる値だけを評価するようにして回避してください。

    SELECT * WHERE num < TO_EPOCH_MS(TIMESTAMP('9999-12-31T23:59:59.999Z')) AND num >= 0 AND TO_TIMESTAMP_MS(num) > TIMESTAMP('2011-01-01T00:00:00Z')
    
  • TO_EPOCH_MS(timestamp)
    timestampで指定した時刻型の値について、時刻1970-01-01T00:00:00Zからのミリ秒単位での経過時間を示すLONG型の値へ変換します。時刻型でない値が指定された場合はエラーになります。この関数はTO_TIMESTAMP_MS関数の逆変換です。

3.2.8 配列型演算

  • ARRAY_LENGTH(array)
    配列の長さを求めます。
  • ELEMENT(n, array)
    特定位置の配列要素を取り出します。長さ1以上の配列でなければなりません。 nには0から始まる要素位置を整数で指定します。 nが浮動小数点数や負の値の場合、nがarrayの長さより長い場合、またarrayの長さが0の場合はエラーになります。 そのため、コレクションに長さが異なる配列が格納されている場合、 以下のような配列要素を指定したクエリは配列要素が取得できない場合にエラーになる可能性があります。
    SELECT * FROM arrays WHERE ELEMENT(1, array) = 1
    

    このようなクエリは以下のようにしてELEMENT関数が評価されるのを回避してください。

    SELECT * FROM arrays WHERE ARRAY_LENGTH(array)>= 1 AND ELEMENT(1, array) = 1
    

3.2.9 空間型演算

空間型データは、OpenGISなどGISの分野で広く用いられています。 TQLでは、2次元もしくは3次元の空間構造を扱い、生成関数ならびに判定関数を提供します。

  • ST_GeomFromText(text)
    WKT表現の文字列から空間型データを生成します。

    WKTとは、空間構造を文字列として表現するための規格です。 このうちTQLでは、次の構造のみをサポートします。

    • POINT: 2次元または3次元座標により表現される点
    • LINESTRING: 2つ以上の点により表現される、2次元または3次元空間上の直線の集合
    • POLYGON: 直線の集合により表現される、2次元または3次元空間上の閉じた領域
    • POLYHEDRALSURFACE: 指定した領域の集合により表現される、3次元空間上の領域
    • QUADRATICSURFACE: 定義式f(X) = <AX, X> + BX + cにより表現される、3次元空間上の2次曲面

    ただし、座標を構成する数値として無限大もしくは非数を含めることはできません。 そのほか、サポート外の空間構造を与えることはできません。

    2次元空間上の点(0, 0)、(10, 10)を対角線とする矩形の場合、次のように表記します。

    POLYGON((0 0,10 0,10 10,0 10,0 0))
    

    また、各種別の空間構造データ型について、空ジオメトリと呼ばれる、特定の空間範囲と対応しない値を表現できます。次の例のように、座標値の代わりに「EMPTY」と記述します。

    LINESTRING(EMPTY)
    

    また、「;」の後ろに整数を記述することにより、SRIDを指定できます。 次の例では、矩形がSRID:4326の座標系にあることを示します。

    POLYGON((0 0,10 0,10 10,0 10,0 0);4326)
    

    ただし、このSRIDの表す座標系による座標の範囲制限や、SRIDの変更による座標変換には対応していません。 SRIDを指定しない場合、無効なSRIDとして-1が設定されます。

  • ST_MakeRect(p1, p2)
    2次元空間の点p1、p2を対角線とする矩形を生成します。p1, p2が同一の点の場合、またはp1, p2のx座標、y座標のいずれかが等しい場合は矩形を形成できないためエラーになります。
  • ST_MakeRect(x1, y1, x2, y2)
    2次元空間の点(x1, y1)、(x2, y2)を対角線とする矩形を生成します。x1がx2と等しい場合、もしくはy1がy2と等しい場合は矩形を形成できないためエラーになります。
  • ST_MakeBox(p1, p2)
    3次元空間の点p1、p2を対角線とする直方体を生成します。 p1, p2が同一の点の場合、またはp1, p2のx座標、y座標、z座標のいずれかが等しい場合は直方体を形成できないためエラーになります。
  • ST_MakeBox(x1, y1, z1, x2, y2, z2)
    3次元空間の点(x1, y1, z1)、(x2, y2, z2)を対角線とする直方体を生成します。 x1がx2と等しい場合、y1がy2と等しい場合、z1がz2と等しい場合は直方体を形成できないためエラーになります。
  • ST_MakePlane(p0x, p0y, p0z, vx, vy, vz)
    3次元空間の点p0、法線ベクトルvから平面を作成します。 vの長さが0の場合、未定義の平面を作成します。この未定義の平面はどのような空間構造とも交差しません。
  • ST_MakeCone(p0x, p0y, p0z, vx, vy, vz, deg)
    3次元空間の点p0、軸のベクトルv、軸と母線の角度degから円錐を作成します。 角度degの単位は度です。vの長さが0の場合、エラーになります。 degが0〜90の範囲にない場合でも、degの360で割った余りを用いて、軸の逆ベクトルを考慮して円錐を作成します。
  • ST_MakeSphere(p0x, p0y, p0z, r)
    3次元空間の点p0と半径rから球を生成します。 rが0または負の値の場合、エラーになります。
  • ST_MakeCylinder(p0x, p0y, p0z, vx, vy, vz, r)
    3次元空間の点p0、軸のベクトルv、半径rから円柱を生成します。 vの長さが0の場合はエラーになります。 rが0の場合は直線になります。rが負の値の場合は、-rを指定した場合と同一です。
  • ST_MakeQSF(A00, A01, A02, A10, A11, A12, A20, A21, A22, B0, B1, B2, c)
    定義式f(X) = <AX, X> + BX + cで表現される、3次元空間上の2次曲面を生成します。 定義式が2次曲面として成立しているかどうかは判定しません。
  • ST_MBRIntersects(g1, g2)
    双方の空間範囲の外接直方体(Minimum Bounding Box)が交差するかどうかを判定します。 交差する場合のみ、真を返します。 「交差する」とは「2つの領域に共通する領域がある」ことを意味します。

    g1、g2のいずれについても、2次曲面(QUADRATICSURFACE)は指定できません。 また、POLYHEDRALSURFACEについて、直方体以外の形状、互いに辺を共有しないPOLYGONの組み合わせ、もしくは空間構造として閉じていない形状を指定した場合、結果は未定義となります。

    一方がx、y座標からなる2次元空間構造、他方がx、y、z座標からなる3次元空間構造の場合、z座標を除いたx、y座標のみを判定対象とします。 たとえば、POINT(x0 y0)とLINESTRING(x1 y1 z1, x2 y2 z2)についての交差判定の結果は、x1 <= x0 <= x2かつy1 <= y0 <= y2が成立する場合のみ真となります。

    一方または双方が空ジオメトリの場合、偽を返します。

    外接直方体は、構造の種類に応じて以下のように定義されます。

    • POINT: 全ての頂点が同一であり、各辺の長さが0の直方体。構造が2次元の場合、直方体のz座標の範囲は(-∞,∞)として扱います。
    • LINESTRING、POLYGON、POLYHEDRALSURFACE: 構造を構成する点のx、y、z座標の最小値と最大値で構成される直方体。構造が2次元の場合、直方体のz座標の範囲は(-∞,∞)として扱います。

    例) カラムgeom上の空間型データと指定の矩形範囲とが交差するようなロウを選択する

    SELECT * WHERE ST_MBRIntersects(geom, ST_GeomFromText('POLYGON((0 0,10 0,10 10,0 10,0 0))'))
    
  • ST_QSFMBRIntersects(q, g)
    2次曲面qと、2次曲面以外の空間構造gの外接直方体とが交差するかどうかを判定します。交差する場合のみ、真を返します。 qに2次曲面以外、gに2次曲面を与えることはできません。 また、gに2次元空間構造を与えることはできません。 そのほかの交差判定の条件は、ST_MBRIntersectsと同様です。
  • ST_GetSrId(g)
    空間構造gのSRIDを取得します。gがSRIDを持たない場合、無効なSRID (-1)が返ります。

3.3 選択式

3.3.1 基本構文

対象カラムや集計方法などを記述する、選択式の構文を定義します。処理対象となるロウは、FROM節、WHERE節の条件に合致したものに限定されます。

  • *(アスタリスク)
    条件に合致したすべてのロウをそのまま選択します。ORDER BY節(後述)を指定することでカラムの値によって並べ替えることができます。
  • (演算関数)
    後述の演算関数のうちいずれか1つの関数により、集計・選択などの演算を行います。

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

3.3.2 集計演算 — 一般

任意のロウ集合に対して、集計演算を行います。

集計対象となるロウが1つも存在しない場合、COUNT関数を除き結果件数は0件となります。それ以外の場合、結果件数は1件となります。 集計演算では特に記載がないかぎり、指定したカラムの値がNULLの場合は評価対象から外れます。

  • MAX(column)
    指定カラムの値の最大値を求めます。数値型または時刻型のカラムのみ指定できます。演算結果の型は、指定カラムと同一の型となります。
  • MIN(column)
    指定カラムの値の最小値を求めます。数値型または時刻型のカラムのみ指定できます。演算結果の型は、指定カラムと同一の型となります。
  • COUNT(*)
    集計対象のロウの個数を求めます。カラムは指定できません。演算結果の型は常にLONGとなります。対象となるロウが1つも存在しない場合、演算結果の値は0となります。 COUNT(*)はNULLを含むロウも評価対象になります。
  • SUM(column)
    指定のカラムの値の合計値を求めます。数値型のカラムのみ指定できます。演算結果の型は、対象のカラムが整数型の場合LONG、浮動小数点型の場合DOUBLEとなります。
  • AVG(column)
    指定のカラムの値の平均を求めます。数値型のカラムのみ指定できます。演算結果の型は常にDOUBLEとなります。
  • VARIANCE(column)
    指定のカラムの値の分散値を求めます。数値型のカラムのみ指定できます。演算結果の型は常にDOUBLEとなります。
  • STDDEV(column)
    指定のカラムの値の標準偏差を求めます。数値型のカラムのみ指定できます。演算結果の型は常にDOUBLEとなります。

3.3.3 集計演算 — 時系列

時系列のロウ集合に対して、集計演算を行います。

ロウの時刻に基づき重み付けを行う集計演算では、条件に合致した各ロウについて、前後それぞれの時刻のロウとの中間時刻間の期間を特定の単位で換算したものを、重み付け値として使用します。ただし、前後いずれかの時刻のロウのみが存在しない場合は、存在しないロウの代わりに重み付け対象のロウを用いて求めた重み付け値を使用します。前後いずれの時刻のロウも存在しない場合は、重み付け値として1(単位は前後いずれかのロウが存在する場合と同一)を使用します。 集計演算では特に記載がないかぎり、指定したカラムの値がNULLの場合は評価対象から外れます。

  • TIME_AVG(column)
    指定のカラムの値について、ロウの時刻に基づく重み付き平均を求めます。演算結果の型は常にDOUBLEとなります。

    各標本値と重み付け値との積の合計を、各重み付け値の合計で割ることにより求めます。数値型のカラムのみ指定できます。重み付け値の計算方法は、前節の通りです。

    例) プラント1、ポイント103における、2011年7月の平均電圧について、時刻による重み付きで求める

    SELECT TIME_AVG(voltage103) FROM plant1
      WHERE TIMESTAMP('2011-07-01T00:00:00Z') <= timestamp AND timestamp < TIMESTAMP('2011-08-01T00:00:00Z')
    

    ここで、次のような時系列の場合の、重み付き平均値の計算手順の一例を紹介します。

    キー(2011年7月1日0時0分の秒の位)集計対象カラム
    0秒4
    10秒3
    20秒2
    40秒1

    この時系列を次の表のように拡張し、左の列から順に、前後時刻のロウとの中間時刻、重み付け値、標本値(カラムの値)と重みとの積を順に求めます。

    キー集計対象カラム中間時刻(秒の位)中間時刻(前)との差中間時刻(後)との差重み付け値標本値と重みとの積
    0秒4--5 (=5-0)520 (=4*5)
    (中間)-5秒(=(0+10)/2)----
    10秒3-5 (=10-5)5 (=15-10)10 (=5+5)30 (=3*10)
    (中間)-15秒(=(10+20)/2)----
    20秒2-5 (=20-15)10 (=30-20)15 (=5+10)30 (=2*15)
    (中間)-30秒(=(20+40)/2)----
    40秒1-10 (=40-30)-1010 (=1*10)

    最後に、標本値と重みとの積、重み付け値をそれぞれ合計し、商を求めます。この時系列の場合、(20+30+30+10)/(5+10+15+10)=90/40=2.25となります。以上の手順は、必ずしもGridDB内部の演算手順と同一であるとは限りません。

    なお、通常の重みなし平均値の場合、(4+3+2+1)/4=10/4=2.5となります。

3.3.4 時系列データ選択・補間演算

  • TIME_NEXT(*, timestamp)
    指定の時刻と同一またはその直後の時刻を持つ1つの時系列ロウを選択します。

    例) プラント1における、2011年7月初めの時点の温度を求める

    SELECT TIME_NEXT(*, TIMESTAMP('2011-07-01T00:00:00Z')) FROM plant1
    
  • TIME_NEXT_ONLY(*, timestamp)
    指定の時刻の直後の時刻を持つ1つの時系列ロウを選択します。
  • TIME_PREV(*, timestamp)
    指定の時刻と同一またはその直前の時刻を持つ1つの時系列ロウを選択します。
  • TIME_PREV_ONLY(*, timestamp)
    指定の時刻の直前の時刻を持つ1つの時系列ロウを選択します。
  • TIME_INTERPOLATED(column, timestamp)
    指定の時刻に関して、一致する時系列ロウの指定のカラムの値、もしくは、前後時刻のロウの指定カラムの値を線形補間して得られた値を求めます。前後時刻のロウの指定カラムのいずれか一方がNULLの場合はNULLが設定されます。 前後時刻のロウの少なくともいずれか、もしくは、一致するロウが存在しない場合、目的のロウは生成されず、結果件数は0件となります。数値型のカラムのみ指定できます。指定のカラムならびにキー以外のフィールドには、指定時刻と同一またはより前の時刻のロウのうち、最も新しい時刻を持つロウのフィールドの値が設定されます。
  • TIME_SAMPLING(*|column, timestamp_start, timestamp_end, interval, DAY|HOUR|MINUTE|SECOND|MILLISECOND)
    開始・終了時刻を指定して、特定範囲のロウ集合をサンプリングします。

    サンプリング位置の時刻は、開始時刻に対し非負整数倍のサンプリング間隔を加えた時刻のうち、終了時刻と同じかそれ以前のもののみです。

    各サンプリング位置の時刻と一致するロウが存在する場合は該当ロウの値を使用します。存在しない場合は補間された値を使用します。補間対象のロウフィールドのうち指定のカラムのものは、サンプリング時刻の前後時刻のロウの値より線形補間して求めた値を使用します。前後時刻のロウの指定カラムのいずれか一方がNULLの場合はNULLが設定されます。それ以外のフィールドには、対象地点の時刻より前の時刻のロウのうち、最も新しい時刻を持つロウの値を補間値として使用します。線形補間対象のカラムの型は、すべて数値型でなければなりません。カラムを具体的に指定せず、「*」を指定した場合、すべてのフィールドについて後者の補間方法により値を求めます。

    補間のために参照する必要のあるロウが存在しない場合、該当するサンプリング時刻のロウは生成されず、該当箇所の数だけ結果件数が減少します。サンプリング間隔をより短く設定すると、線形補間対象外のカラムについては、異なるサンプリング時刻であっても同一のロウの内容が使用される可能性が高まります。サンプリング間隔に対応する引数intervalには正の値のみ指定できます。

    例) プラント1、ポイント103における、2011年7月1日の毎時ごとの電圧を求める

    SELECT TIME_SAMPLING(
      voltage103, TIMESTAMP('2011-07-01T00:00:00Z'), TIMESTAMP('2011-07-02T00:00:00Z'), 1, HOUR) FROM plant1
    

    また、このサンプリング結果についてORDER BY節(後述)を記述してカラム順に並べ替えることができます。 例) プラント1、ポイント103における、2011年7月1日の毎時ごとの電圧を求め、電圧順に並び替える

    SELECT TIME_SAMPLING(
      voltage103, TIMESTAMP('2011-07-01T00:00:00Z'), TIMESTAMP('2011-07-02T00:00:00Z'), 1, HOUR) FROM plant1 ORDER BY voltage103
    

3.3.5 最大値・最小値のロウ集合選択演算

任意のロウ集合に対して、指定カラムの値で最大値もしくは最小値をもつロウ集合を返します。 集計演算では特に記載がないかぎり、指定したカラムの値がNULLの場合は評価対象から外れます。

  • MAX_ROWS(column)
    指定カラムの値で最大値をもつロウ集合を求めます。数値型または時刻型のカラムのみ指定できます。
  • MIN_ROWS(column)
    指定カラムの値で最小値をもつロウ集合を求めます。数値型または時刻型のカラムのみ指定できます。

3.4 検索結果の並び替え(ORDER BY)

ORDER BY節を記述することで、検索結果の並び替えの順序を指定することができます。 ORDER BY節の記述は以下のように定義されます。

ORDER BY (カラム名) [ASC|DESC] [, (カラム名) [ASC|DESC]]*

ただし'*'は前要素の0回以上の繰り返しとします。

ASCは昇順指定を表しており、DESCは降順指定を表します。指定を省略すると昇順を指定したものとみなします。 複数ソート条件が記述された場合、先頭の条件から順に優先されます。 NULLは最も大きな値としてソートされます。

例) aの降順を第一ソート条件、bの昇順を第二ソート条件, cの昇順を第三ソート条件として検索する

SELECT * ORDER BY a DESC, b ASC, c

SQLとは異なり、ソート条件に計算式や関数を指定することはできません。

3.5 検索結果の取得件数、相対位置指定(LIMIT, OFFSET)

LIMIT節を記述することで、検索結果の取得個数を制限できます。 また、OFFSETを指定することで、検索結果の取得の開始位置を指定できます。 LIMIT, OFFSET指定の文法は以下の通り定義されます。

LIMIT (数値) [OFFSET (数値)]

OFFSETは必ずLIMITと共に使用されます。省略するとOFFSET 0と同義です。 LIMIT, OFFSETの数値に負の値や浮動小数点数を指定することはできません。

LIMIT, OFFSETの数値に計算式や関数を指定することはできません。

3.6 実行プラン情報の取得・実行結果の解析

SELECT文の前にEXPLAINまたはEXPLAIN ANALYZEを付けることで、実行プラン情報ならびに実行結果の解析情報が求まります。

取得結果は、ロウと同様の構造からなる、次のエントリの列により構成されます。

名称説明
IDINTEGER型一連のエントリ列における、このエントリの位置を示すIDです。
DEPTHINTEGER型他のエントリとの関係を表すための、深さを表します。このエントリより小さな値のIDを順にたどり、このエントリの深さより1だけ浅いエントリが存在した場合、このエントリは、該当するエントリの内容をより詳しく説明するためのものであることを意味します。
TYPE文字列型このエントリが示す情報の種別を表します。実行時間といった解析結果の種別、クエリプランの構成要素の種別などを表します。
VALUE_TYPE文字列型このエントリが示す情報に対応付けられた値の型を表します。実行時間といった解析結果などに対応する値の型を返します。型の名称は、TQLで定義された基本型のものと同一です。値が対応づけられていない場合は空文字列が設定されます。
VALUE文字列型このエントリが示す情報に対応付けられた値の文字列表現を表します。値が対応づけられていない場合は空文字列が設定されます。
STATEMENT文字列型このエントリが示す情報に対応するTQL文の一部を返します。対応関係を持たない場合は空文字列が設定されます。

3.6.1 EXPLAIN

後続のSELECT文に関する実行プラン情報を求めます。SELECT文自体は実行しません。

同一のクエリ文であっても、索引設定などにより結果が異なる場合があります。

3.6.2 EXPLAIN ANALYZE

後続のSELECT文に関する実行プラン情報を取得するとともに、SELECT文を実行し、実行時間などの解析情報を求めます。

4 トリガ機能

トリガが設定されたコンテナに対して更新操作(ロウの登録/更新、削除)がなされた時、Java Messaging Service(JMS)またはRESTを用いて通知を行なうことができます。 前者をJMS通知、後者をREST通知と呼びます。

4.1 機能概要

  • API操作
    • APIで操作できる機能は、トリガ設定、トリガ解除、トリガ情報取得の3つです。
  • 通知タイミング
    • ロウの新規作成または更新、削除が行われたタイミングで通知を行ないます。
    • レプリケーション完了までは待ちません。また、自動コミットモードでない場合は、未コミットの状態で通知を行ないます。
  • 通知内容
    • コンテナ名、操作の種類(ロウの新規作成または更新、削除)、を通知します。
    • 通知対象カラムの指定がある場合、操作が行われたロウの指定されたカラムの値も併せて通知します。
  • エラー発生時の処理
    • 通知時にエラーが発生した場合はイベントログにエラー情報を記録します。再送は行いません。
  • その他
    • 複数のロウを一括して新規作成・更新する操作を行った場合、個別のロウ単位で通知を行ないます。この操作は、Java APIの場合Container#put(java.util.Collection)もしくはGridStore#multiPut(Map)の呼び出しに相当します。
    • トリガが設定されたコンテナのスキーマを変更した場合、トリガは変更後のコンテナに引き継がれますが、変更後のスキーマに含まれないカラムは通知対象カラム名集合から自動的に削除されます。
    • 同一のコンテナに対しJMS通知とREST通知の両方を設定することは可能ですが、トリガ名は別にする必要があります。

4.2 API概要

  • トリガ設定
    • void Container#createTrigger(TriggerInfo info)
    • コンテナにトリガを設定します。
    • JMS通知・REST通知共通の設定内容として、トリガ名、通知方法、監視対象操作(ロウの新規作成または更新、削除)、通知対象カラム、通知先URI、があります。また、JMS通知だけの設定内容として、ディスティネーション名、ユーザ名、パスワード、があります。これらの情報はTriggerInfoオブジェクト経由で設定します。
    • トリガ名はコンテナごとにユニークでなければなりません。
    • 既に設定済のトリガ名を指定して設定した場合、設定内容を上書きします。
    • トリガ設定時に通知先URI、デスティネーション名、ユーザ名、パスワードの有効性は確認しません。
    • JMS通知について
      • ユーザ名、パスワードが未設定の場合はユーザ名、パスワードを使用せずに接続を行ないます。
      • 通知モードはSession#AUTO_ACKNOWLEDGE、配信モードはDeliveryMode#PERSISTENTとします。
        JMS通知REST通知
        トリガ名
        通知方法
        監視対象更新操作
        通知対象カラム
        通知先URL
        デスティネーション種別×
        デスティネーション名×
        ユーザ名×
        パスワード×
  • トリガ解除
    • void Container#dropTrigger(String name)
    • コンテナに設定されていたトリガを解除します。
  • トリガ情報取得
    • List<TriggerInfo> ContainerInfo#getTriggerInfoList()
    • トリガの設定情報を取得します。Containerオブジェクトに対してgetContainerInfo()を実行して得られるContainerInfoオブジェクトを用います。

4.3 メッセージフォーマット

  • JMS通知
    • 送信側
      • プロパティにコンテナ名、更新操作の種類、ロウデータを設定します。ボディには何も設定されません。
    • 受信側
      • メッセージの種類、ロウデータのスキーマを知っていることを前提とします。
      • JMSのTextMessageを使用して通知内容を取得します。プロパティ名の一覧はTextMessage#getPropetyNames()で得られます。
      • コンテナ名
        • プロパティ名は@containerです。ロウデータのカラム名と重複しないように先頭に@を付けます。
        • TextMessage#getStringProperty()で取得します。例: getStringProperty("@container")
      • 更新操作の種類
        • プロパティ名は@eventです。ロウデータのカラム名と重複しないように先頭に@を付けます。更新操作の種類は"put"・"delete"の2種類です。
        • TextMessage#getStringProperty()で取得します。例: getStringProperty("@event")
      • ロウデータ
        • ブール型、整数型、浮動小数点型は型に対応するTextMessage#getXXXProperty()で取得します。例: FLOAT型はgetFloatProperty("カラム名")
        • 時刻型は送信側で時刻1970-01-01T00:00:00Zからの経過時間(LONG型)に変換した値を設定します。そのため、受信側ではTextMessage#getLongProperty()で取得した値を時刻型に戻してください。
        • 空間型・BLOB型・配列型は、TextMessage#getStringProperty()で取得します。送信側で空文字列を設定するため、必ず空文字列となります。
  • REST通知
    • 送信側
      • 以下のJSON文字列をHTTPリクエストのボディに設定してPOSTします。
      • "row"の値は指定された通知対象カラムのみを設定します。指定がない場合は"row"自体を設定しません。
      • "row"の各カラムの値は以下の値とします。
        • ブール型: "true"(真)もしくは"false"(偽)
        • 整数型・時刻型: 整数
        • 浮動小数点型: 浮動小数点
        • 文字列型: 文字列
        • 空間型・BLOB型・配列型: 空文字列
      • 通知対象カラムの値がNULLの場合は"row"自体を設定しません。
※JSON文字列
{
  "container":"(コンテナ名)",
  "event":"(更新操作の種類)",
  "row":{
    "(カラム名0)":"(カラム名0の値)",
    "(カラム名1)":"(カラム名1の値)",
    "(カラム名2)":"(カラム名2の値)",
    ...
  }
}

4.4 注意事項

  • トリガ設定と更新性能に関する注意
    • トリガが発火するコンテナ数、及び発火するトリガ数に応じて更新性能が低下します。トリガが必要なコンテナだけに最小限のトリガ付与を行うようにしてください。
  • トリガ通知先サーバの処理性能に関する注意
    • GridDBの更新処理のスループットに比べて通知先サーバのスループットが極端に低い場合、トリガ処理に失敗しイベントログにエラーメッセージが記録されることがあります。トリガ設定されているコンテナを高頻度で更新する場合、通知先サーバの性能も確認、調整してください。

5 API (Java)

5.1 API一覧(Java)

Package com.toshiba.mwcloud.gs

GridDBの公開インタフェースを定義します。

See: Description

  • Interface Summary 
    Interface Description
    AggregationResult
    集計演算の結果を保持します。
    Collection<K,R>
    ロウ集合を汎用的に管理するためのコンテナです。
    Container<K,R>
    同一タイプのロウ集合からなるGridDBの構成要素に対しての、管理機能を提供します。
    GridStore
    接続したGridDBシステム内のデータベースに属するデータを操作するための機能を提供します。
    PartitionController
    パーティション状態の取得や操作のためのコントローラです。
    Query<R>
    特定のContainerに対応付けられたクエリを保持し、結果取得方法の設定ならびに実行・結果取得を行う機能を持ちます。
    Row
    任意のスキーマについて汎用的にフィールド操作できるロウです。
    RowSet<R>
    クエリ実行より求めたロウの集合を管理します。
    TimeSeries<R>
    時刻をロウキーとする、時系列処理に特化したコンテナです。
  • Class Summary 
    Class Description
    ColumnInfo
    カラムのスキーマに関する情報を表します。
    ContainerInfo
    特定のコンテナに関する情報を表します。
    Geometry
    2次元、もしくは3次元の空間範囲を示すジオメトリデータを管理します。
    GridStoreFactory
    GridStoreインスタンスを管理します。
    IndexInfo
    索引の設定内容を表します。
    QueryAnalysisEntry
    クエリプランならびにクエリ処理解析結果を構成する一連の情報の一つを示します。
    RowKeyPredicate<K>
    ロウキーの合致条件を表します。
    TimeSeriesProperties
    時系列を新規作成または変更する際に使用される、オプションの構成情報を表します。
    TimestampUtils
    時刻データを操作するためのユーティリティ機能を提供します。
    TriggerInfo
    コンテナの更新を監視するためのトリガ情報を表します。
  • Enum Summary 
    Enum Description
    Aggregation
    ロウ集合またはその特定のカラムに対する、集計演算の方法を示します。
    CompressionMethod
    圧縮方式の種別を表します。
    ContainerType
    コンテナの種別を表します。
    FetchOption
    クエリ実行結果を取得する際のオプション項目です。
    GeometryOperator
    空間範囲同士の関係性についての制約を定義します。
    GSType
    GridDB上のフィールド値の型を表します。
    IndexType
    Containerに設定する索引の種別を示します。
    InterpolationMode
    ロウの補間方法の種別を表します。
    QueryOrder
    クエリにおける要求ロウ順序を表します。
    TimeOperator
    TimeSeriesのキー時刻に基づく、ロウの特定方法を表します。
    TimeUnit
    時系列処理で用いる時間の単位を示します。
    TriggerInfo.EventType
    トリガで監視対象とする更新操作種別を表します。
    TriggerInfo.Type
    トリガの種別を表します。
  • Exception Summary 
    Exception Description
    GSException
    GridDB機能の処理中に発生した例外状態を示します。
    GSTimeoutException
    要求した処理が既定の時間内に終了しなかったことを示す例外です。
  • Annotation Types Summary 
    Annotation Type Description
    NotNull
    NOT NULL制約を持つカラムであることを示します。
    Nullable
    NOT NULL制約を持たないカラムであることを示します。
    RowField
    Containerの処理におけるマッピング対象のロウフィールドについて、オプションを設定します。
    RowKey
    Containerのキーと対応することを示します。
    TransientRowField
    Containerの処理において、マッピング対象外のロウフィールドであることを宣言します。

Package com.toshiba.mwcloud.gs Description

GridDBの公開インタフェースを定義します。

Enum Aggregation

  • java.lang.Object
    • java.lang.Enum<Aggregation>
      • com.toshiba.mwcloud.gs.Aggregation
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Aggregation>


    public enum Aggregation
    extends java.lang.Enum<Aggregation>
    ロウ集合またはその特定のカラムに対する、集計演算の方法を示します。

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

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

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      AVERAGE
      平均を求める演算です。
      COUNT
      標本数、すなわち対象ロウの個数を求める演算です。
      MAXIMUM
      最大値を求める演算です。
      MINIMUM
      最小値を求める演算です。
      STANDARD_DEVIATION
      標準偏差を求める演算です。
      TOTAL
      合計を求める演算です。
      VARIANCE
      分散を求める演算です。
      WEIGHTED_AVERAGE
      重み付きで平均を求める演算です。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static Aggregation valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Aggregation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • AVERAGE

        public static final Aggregation AVERAGE
        平均を求める演算です。

        数値型のカラムに対してのみ使用できます。演算結果の型は常にDOUBLEとなります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • COUNT

        public static final Aggregation COUNT
        標本数、すなわち対象ロウの個数を求める演算です。

        任意のカラムに対して使用できます。演算結果の型は常にLONGとなります。対象となるロウが1つも存在しない場合、演算結果の値は0となります。

      • MAXIMUM

        public static final Aggregation MAXIMUM
        最大値を求める演算です。

        大小比較できる型、すなわち数値型や時刻型のカラムに対してのみ使用できます。演算結果の型は、対象のカラムと同一の型となります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • MINIMUM

        public static final Aggregation MINIMUM
        最小値を求める演算です。

        大小比較できる型、すなわち数値型や時刻型のカラムに対してのみ使用できます。演算結果の型は、対象のカラムと同一の型となります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • STANDARD_DEVIATION

        public static final Aggregation STANDARD_DEVIATION
        標準偏差を求める演算です。

        数値型のカラムに対してのみ使用できます。演算結果の型は常にDOUBLEとなります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • TOTAL

        public static final Aggregation TOTAL
        合計を求める演算です。

        数値型のカラムに対してのみ使用できます。演算結果の型は、対象のカラムが整数型の場合LONG、浮動小数点型の場合DOUBLEとなります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • VARIANCE

        public static final Aggregation VARIANCE
        分散を求める演算です。

        数値型のカラムに対してのみ使用できます。演算結果の型は常にDOUBLEとなります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

      • WEIGHTED_AVERAGE

        public static final Aggregation WEIGHTED_AVERAGE
        重み付きで平均を求める演算です。

        各標本値と重み付け値との積の合計を、各重み付け値の合計で割ることにより求めます。重み付け値の計算方法は、Aggregationの説明を参照してください。

        この演算は、数値型のカラムに対してのみ使用できます。演算結果の型は常にDOUBLEとなります。対象となるロウが1つも存在しない場合、演算結果は設定されません。

    • Method Detail

      • valueOf

        public static Aggregation valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static Aggregation[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Aggregation c : Aggregation.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Interface AggregationResult



  • public interface AggregationResult
    集計演算の結果を保持します。

    集計演算に関するクエリの実行もしくは TimeSeries.aggregate(Date, Date, String, Aggregation) により取得できる、集計演算の結果を保持します。整数型カラムに対する演算結果を浮動小数点型として、また、有効桁数の少ない数値型のカラムに対する演算結果をより桁数の多い数値型として受け取ることができます。

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

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

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Double getDouble()
      数値型の集計値をDOUBLE型(Double)として取得します。
      java.lang.Long getLong()
      数値型の集計値をLONG型(Long)として取得します。
      java.util.Date getTimestamp()
      時刻型の集計値をTIMESTAMP型(Date)で取得します。
    • Method Detail

      • getDouble

        java.lang.Double getDouble()
        数値型の集計値をDOUBLE型(Double)として取得します。

        数値型以外の値を保持している場合、nullを返します。 DOUBLE型以外の数値を保持している場合、DOUBLE型に変換したものを返します。

        Returns:
        DOUBLE型(Double)の集計値。結果が数値型以外の場合は null
      • getLong

        java.lang.Long getLong()
        数値型の集計値をLONG型(Long)として取得します。

        数値型以外の値を保持している場合、nullを返します。 LONG型以外の数値を保持している場合、LONG型に変換したものを返します。

        Returns:
        LONG型(Double)の集計値。結果が数値型以外の場合は null
      • getTimestamp

        java.util.Date getTimestamp()
        時刻型の集計値をTIMESTAMP型(Date)で取得します。

        TIMESTAMP型以外の値を保持している場合、nullを返します。

        Returns:
        TIMESTAMP型(Date)の集計値。結果がTIMESTAMP型以外の場合はnull

Interface Collection<K,R>

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, Container<K,R>


    public interface Collection<K,R>
    extends Container<K,R>
    ロウ集合を汎用的に管理するためのコンテナです。

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

    • 文字列型(String)
    • INTEGER型(Integer)
    • LONG型(Long)
    • TIMESTAMP型(Date)

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

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

    Container.query(String)もしくはGridStore.multiGet(java.util.Map) などより複数のロウの内容を一度に取得する場合、特に指定がなければ、返却されるロウの順序は不定となります。

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

    • Method Detail

      • query

        Query<R> query(java.lang.String column,
                     Geometry geometryIntersection,
                     Geometry geometryDisjoint)
                       throws GSException
        除外範囲付きの空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。

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

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

        現バージョンでは、GSExceptionは送出されません。カラム名の誤りなどがあった場合、得られたクエリをフェッチする際に例外が送出されます。

        Parameters:
        column - 比較対象の空間型カラムの名前
        geometryIntersection - カラム上の値と交差する範囲を示す空間構造
        geometryDisjoint - カラム上の値と交差しない範囲を示す空間構造
        Throws:
        GSException - 現バージョンでは送出されない
      • query

        Query<R> query(java.lang.String column,
                     Geometry geometry,
                     GeometryOperator geometryOp)
                       throws GSException
        指定した空間範囲条件に合致するロウ集合を求めるための、クエリを作成します。

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

        現バージョンでは、GSExceptionは送出されません。カラム名の誤りなどがあった場合、得られたクエリをフェッチする際に例外が送出されます。

        Parameters:
        column - 比較対象の空間型カラムの名前
        geometry - 比較対象として与える空間構造
        geometryOp - 比較方法
        Throws:
        GSException - 現バージョンでは送出されない

Class ColumnInfo

  • java.lang.Object
    • com.toshiba.mwcloud.gs.ColumnInfo


  • public class ColumnInfo
    extends java.lang.Object
    カラムのスキーマに関する情報を表します。

    カラム名の表記、もしくは、カラムの型と索引種別の対応関係などの内容の妥当性について、必ずしも検査するとは限りません。

    • Constructor Summary

      Constructors 
      Constructor and Description
      ColumnInfo(java.lang.String name, GSType type)
      カラム名、型を指定してカラム情報を作成します。
      ColumnInfo(java.lang.String name, GSType type, java.lang.Boolean nullable, java.util.Set<IndexType> indexTypes)
      カラム名、型、NOT NULL制約の状態、索引種別の集合を指定してカラム情報を作成します。
      ColumnInfo(java.lang.String name, GSType type, java.util.Set<IndexType> indexTypes)
      カラム名、型、索引種別の集合を指定してカラム情報を作成します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.Set<IndexType> getIndexTypes()
      このカラムのすべての索引種別を取得します。
      java.lang.String getName()
      カラム名を取得します。
      java.lang.Boolean getNullable()
      カラムにNOT NULL制約が設定されていないかどうかを取得します。
      GSType getType()
      カラムの型、すなわち、カラムに対応する各フィールド値の型を取得します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ColumnInfo

        public ColumnInfo(java.lang.String name,
                  GSType type)
        カラム名、型を指定してカラム情報を作成します。
        Parameters:
        name - カラム名。nullを指定すると未設定状態となる
        type - カラムの型。nullも指定すると未設定状態となる
        Since:
        1.5
      • ColumnInfo

        public ColumnInfo(java.lang.String name,
                  GSType type,
                  java.lang.Boolean nullable,
                  java.util.Set<IndexType> indexTypes)
        カラム名、型、NOT NULL制約の状態、索引種別の集合を指定してカラム情報を作成します。

        空ではない索引種別の集合が指定された場合、内容が複製されます。

        Parameters:
        name - カラム名。nullを指定すると未設定状態となる
        type - カラムの型。nullを指定すると未設定状態となる
        nullable - NOT NULL制約が設定されていない場合はtrue、設定されている場合はfalsenullを指定すると未設定状態となる
        indexTypes - 索引種別の集合。nullを指定すると未設定状態となる。空の場合は索引の設定が一つもないとみなされる
        Since:
        3.5
      • ColumnInfo

        public ColumnInfo(java.lang.String name,
                  GSType type,
                  java.util.Set<IndexType> indexTypes)
        カラム名、型、索引種別の集合を指定してカラム情報を作成します。

        空ではない索引種別の集合が指定された場合、内容が複製されます。

        Parameters:
        name - カラム名。nullを指定すると未設定状態となる
        type - カラムの型。nullを指定すると未設定状態となる
        indexTypes - 索引種別の集合。nullを指定すると未設定状態となる。空の場合は索引の設定が一つもないとみなされる
        Since:
        1.5
    • Method Detail

      • getIndexTypes

        public java.util.Set<IndexType> getIndexTypes()
        このカラムのすべての索引種別を取得します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Returns:
        索引種別の集合。未設定の場合はnull
        Since:
        1.5
      • getName

        public java.lang.String getName()
        カラム名を取得します。
        Returns:
        カラム名。未設定の場合はnull
      • getNullable

        public java.lang.Boolean getNullable()
        カラムにNOT NULL制約が設定されていないかどうかを取得します。
        Returns:
        NOT NULL制約が設定されていない場合はtrue、設定されている場合はfalse、未設定の場合はnull
        Since:
        3.5
      • getType

        public GSType getType()
        カラムの型、すなわち、カラムに対応する各フィールド値の型を取得します。
        Returns:
        カラムの型。未設定の場合はnull

Enum CompressionMethod

  • java.lang.Object
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CompressionMethod>


    public enum CompressionMethod
    extends java.lang.Enum<CompressionMethod>
    圧縮方式の種別を表します。

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      HI
      誤差あり間引き圧縮方式であることを示します。
      NO
      無圧縮であることを示します。
      SS
      誤差なし間引き圧縮方式であることを示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static CompressionMethod valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CompressionMethod[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • HI

        public static final CompressionMethod HI
        誤差あり間引き圧縮方式であることを示します。

        誤差あり間引き圧縮では、前回まで及び直後に登録したデータと同じ傾斜を表すロウは省かれます。同じ傾斜かを判定する条件はユーザが指定できます。指定されたカラムが条件を満たし、それ以外のカラムの値が前回のデータと同じ場合のみ省かれます。省かれたデータはinterpolateやsample処理の際に、指定された誤差の範囲内で復元されます。

      • NO

        public static final CompressionMethod NO
        無圧縮であることを示します。
      • SS

        public static final CompressionMethod SS
        誤差なし間引き圧縮方式であることを示します。

        誤差なし間引き圧縮では、直前及び直後に登録したロウと同じデータを持つロウは省かれます。省かれたデータはinterpolateやsample処理の際に、誤差を発生することなく復元されます。

    • Method Detail

      • valueOf

        public static CompressionMethod valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static CompressionMethod[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CompressionMethod c : CompressionMethod.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Interface Container<K,R>

  • Type Parameters:
    K - ロウキーの型。ロウキーが存在しない場合はVoidを指定
    R - マッピングに用いるロウオブジェクトの型
    All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable
    All Known Subinterfaces:
    Collection<K,R>, TimeSeries<R>


    public interface Container<K,R>
    extends java.io.Closeable
    同一タイプのロウ集合からなるGridDBの構成要素に対しての、管理機能を提供します。

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

    GridDB上のスキーマを構成する各カラムは、ロウオブジェクト内のフィールドやメソッド定義と対応関係を持ちます。 1つのコンテナは1つ以上のカラムにより構成されます。各カラムとの対応関係は、指定の型のpublic・protected・デフォルトアクセスのフィールドまたはgetter・setterメソッドに基づき決定されます。ただし、TransientRowFieldが指定されたフィールドやメソッド、 transientフィールドは対象外です。また、ロウオブジェクトを動的に生成するために、public・protected・デフォルトアクセスのデフォルトコンストラクタを持つ必要があります。内部クラスの場合、静的内部クラスである必要があります。

    getterは、boolean値を返す場合「is」または「get」、それ以外の型の値を返す場合「get」から始まる名前を持つ、引数なしのメソッドです。 setterは、「set」から始まる名前を持ち、設定対象の値1つのみを引数とするメソッドです。 GridDB上のカラム名は、フィールド名、もしくは、getter・setterのメソッド名から「get」などの固定の接頭辞を除いたものと対応します。カラム名に使用できる文字は、ASCIIの英数字とアンダースコア(「_」)のみです。ただし、先頭に数字は使用できません。また、ASCIIの大文字と小文字は同一視されるため、大文字・小文字だけが異なる名前のカラムを定義することはできません。 getter・setterの一方しか存在しないものは無視されます。同名のフィールドと getter・setterの両方が存在する場合は、getter・setterを使用します。 getter・setter名の大文字・小文字表記が異なる場合、getterのものが優先されます。カラムがロウキーを持つ場合は、対応するフィールドまたはメソッドにRowKeyを設定します。

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

    カラム型ロウオブジェクト内の各値の型
    STRINGString
    BOOLBooleanまたはboolean
    BYTEByteまたはbyte
    SHORTShortまたはshort
    INTEGERIntegerまたはint
    LONGLongまたはlong
    FLOATFloatまたはfloat
    DOUBLEDoubleまたはdouble
    TIMESTAMPDate
    GEOMETRYGeometry
    BLOBBlobを実装したクラス
    STRING配列String[]
    BOOL配列boolean[]
    BYTE配列byte[]
    SHORT配列short[]
    INTEGER配列int[]
    LONG配列long[]
    FLOAT配列float[]
    DOUBLE配列double[]
    TIMESTAMP配列java.util.Date[]

    カラム数、カラム名の長さには上限があります。また、フィールドの値には、表現範囲やサイズに制限があります。具体的には、GridDBテクニカルリファレンスを参照してください。制限に反する値をコンテナに格納することはできません。

    ロウキーとして許可されている型や、ロウキーに対応するカラムの有無、ロウ操作の可否といった制約は、このコンテナのサブインタフェースの定義によって異なります。

    GridDB上のロウにおけるNULLは、NOT NULL制約が設定されていない限り保持することができます。ロウオブジェクトのフィールドまたはgetter・setter メソッドが参照型の値を入出力できる場合、GridDB上のロウにおけるNULLは nullとして入出力できます。それ以外の場合、NULLはロウオブジェクトにおいて後述の空の値にマッピングされます。

    ロウオブジェクト型におけるNOT NULL制約は、NotNullならびに Nullableにより明示的に指定できます。NOT NULL制約がいずれの指定対象にも指定されていない場合、ロウキー以外のカラムはNOT NULL 制約なしであるとみなされます。ロウキーは暗黙的にNOT NULL制約が設定された状態となっており、この制約を外すような指定はできません。また、同一の指定対象や、getter、setterメソッド間での矛盾したNOT NULL制約は指定できません。たとえば、ロウオブジェクト型にNotNullNullableが同時に指定された場合、矛盾したNOT NULL制約が指定されたとみなされます。NOT NULL制約の有無に関する指定対象別の優先順位は、次の通りです。

    1. ロウオブジェクトのフィールドまたはgetter・setterメソッド
    2. ロウオブジェクトの型
    3. ロウオブジェクトのエンクロージング型(例:ロウオブジェクトのクラスを内部クラスとして取り囲むインタフェース)、または、その型から再帰的に求まるエンクロージング型。再帰的に求まるエンクロージング型のうち、制約の指定があり、かつ、最も最初に見つかった型を優先。
    4. ロウオブジェクトの型が属するパッケージ
      1. 空の値は、Rowの作成など各種操作の初期値などとして用いられることのある、フィールド値の一種です。以下のように、カラム型ごとに値が定義されています。

        カラム型空の値
        STRING""(長さ0の文字列)
        BOOL偽(false)
        数値型0
        TIMESTAMP1970-01-01T00:00:00Z
        GEOMETRYPOINT(EMPTY)
        BLOB長さ0のBLOBデータ
        配列型要素数0の配列

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

        このContainerの生成後またはトランザクション終了後、最初にロウの更新・追加・削除、ならびに更新用ロック獲得が行われた時点で、新たなトランザクションが開始されます。自動コミットモードでは、トランザクションを開始したロウ操作が完了するとトランザクションは自動的にコミットされ終了します。手動コミットモードでは、明示的にトランザクションを制御するか有効期限に到達するまでトランザクションは終了しません。トランザクションをコミットするにはcommit()、アボートするにはabort()を使用します。このContainerまたはその生成元のGridStoreがクローズされた場合もトランザクションはアボートされ終了します。また、トランザクションを開始させた操作を行った時刻を起点として、GridDB上で定められている期間だけ経過すると有効期限に到達します。有効期限到達後にアボートすることなく、続けてロウ操作やトランザクションコミットを行おうとすると、GSExceptionが送出されるようになります。

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

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void abort()
      手動コミットモードにおいて、現在のトランザクションの操作結果を元に戻し、トランザクションを終了します。
      void close()
      GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。
      void commit()
      手動コミットモードにおいて、現在のトランザクションにおける操作結果を確定させ、トランザクションを終了します。
      java.sql.Blob createBlob()
      このContainerに対して巨大なバイナリデータを格納するためのBlobを作成します。
      void createIndex(IndexInfo info)
      IndexInfoで設定されている内容に従い、索引を作成します。
      void createIndex(java.lang.String columnName)
      指定された名前のカラムに対し、デフォルトの種別で名前のない索引を作成します。
      void createIndex(java.lang.String columnName, IndexType type)
      指定された名前のカラムに対し、指定された種別で名前のない索引を作成します。
      R createRow()
      このコンテナのカラムレイアウトに基づき、ロウオブジェクトを新規作成します。
      void createTrigger(TriggerInfo info)
      トリガを設定します。
      void dropIndex(IndexInfo info)
      IndexInfoで設定されている内容に一致する、すべての索引を削除します。
      void dropIndex(java.lang.String columnName)
      指定された名前のカラムのうち、デフォルトの種別の索引のみを削除します。
      void dropIndex(java.lang.String columnName, IndexType type)
      指定された名前のカラムのうち、指定された種別の索引のみを削除します。
      void dropTrigger(java.lang.String name)
      トリガを削除します。
      void flush()
      これまでの更新結果をSSDなどの不揮発性記憶媒体に書き出し、すべてのクラスタノードが突然停止したとしても内容が失われないようにします。
      R get(K key)
      指定のロウキーに対応するロウの内容を取得します。
      R get(K key, boolean forUpdate)
      指定のオプションに従い、ロウキーに対応するロウの内容を取得します。
      ContainerType getType()
      このコンテナの種別を取得します。
      boolean put(java.util.Collection<R> rowCollection)
      指定のロウオブジェクト集合に基づき、任意個数のロウをまとめて新規作成または更新します。
      boolean put(K key, R row)
      必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。
      boolean put(R row)
      常にロウオブジェクトのみを指定して、ロウを新規作成または更新します。
      Query<R> query(java.lang.String tql)
      指定のTQL文を実行するためのクエリを作成します。
      <S> Query<S> query(java.lang.String tql, java.lang.Class<S> rowType)
      指定のTQL文・対応付け用クラスを使用する、クエリオブジェクトを作成します。
      boolean remove(K key)
      指定のロウキーに対応するロウを削除します。
      void setAutoCommit(boolean enabled)
      コミットモードの設定を変更します。
    • Method Detail

      • abort

        void abort()
                   throws GSException
        手動コミットモードにおいて、現在のトランザクションの操作結果を元に戻し、トランザクションを終了します。
        Throws:
        GSException - 自動コミットモードのときに呼び出された場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合
      • close

        void close()
                   throws GSException
        GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。

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

        GSExceptionが送出された場合であっても、接続状態の解除やローカルのリソース解放処理は適宜実施されます。ただし、GridDB上のトランザクション状態などは残る可能性があります。すでにクローズ済みの場合、このメソッドを呼び出しても解放処理は行われません。

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        GSException - 接続障害が発生した場合
      • commit

        void commit()
                    throws GSException
        手動コミットモードにおいて、現在のトランザクションにおける操作結果を確定させ、トランザクションを終了します。
        Throws:
        GSException - 自動コミットモードのときに呼び出された場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合
      • createBlob

        java.sql.Blob createBlob()
                                 throws GSException
        このContainerに対して巨大なバイナリデータを格納するためのBlobを作成します。

        作成されたBlobは、ロウのフィールドとして利用できます。まず、Blob.setBinaryStream(long)などを用いてバイナリデータをセットし、続いてput(Object)などを用いてContainerに格納します。

        このメソッドにより得られたBlobに対し、少なくとも次のメソッドを呼び出すことができます。

        • Blob.length()
        • Blob.setBinaryStream(long)
        • Blob.setBytes(long, byte[])
        • Blob.setBytes(long, byte[], int, int)
        • Blob.free()

        ロウオブジェクトに設定するBLOBは、必ずしもこのメソッドで作成した Blobを使う必要はありません。SerialBlobなど、Blobを実装した他のクラスのインスタンスを設定することもできます。また、作成されたBlobに有効期間はありません。

        現バージョンでは、ロウ全体をクライアントのメモリ上にキャッシュするため、このVMのメモリ使用量の制限を超えるような巨大なデータは登録できない可能性があります。

        現バージョンでは、GSExceptionが送出されることはありません。

        Throws:
        GSException
      • createIndex

        void createIndex(IndexInfo info)
                         throws GSException
        IndexInfoで設定されている内容に従い、索引を作成します。

        指定のIndexInfoにおいて、カラム名またはカラム番号の少なくとも一方が設定されており、対応するコンテナにおいて実在するものである必要があります。カラム名とカラム番号が共に指定されていた場合、対応するカラムが一致しなければなりません。

        索引種別が設定されていないかIndexType.DEFAULTが設定されていた場合、後述の基準に従い、デフォルト種別の索引が選択されます。

        索引名が設定されている場合は、対象コンテナに同名の索引が存在しない場合のみ新規に索引が作成されます。索引名に使用できる文字は、 ASCIIの英数字とアンダースコア(「_」)のみです。ただし、先頭に数字は使用できません。また、ASCIIの大文字と小文字は同一視されます。名前の長さの上限についてはGridDBテクニカルリファレンスを参照してください。

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

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

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

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

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

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

        時系列のロウキー(TIMESTAMP型)には索引を設定できません。バージョン1.1またはそれ以前のバージョンにおけるコレクションのGEOMETRY型カラムには、デフォルト索引が選択されませんでした。

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

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

        Throws:
        GSException - 作成対象のカラム、索引名が上記の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        GSException - 指定のカラムにおいてサポートされていない索引種別が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        3.5
      • createIndex

        void createIndex(java.lang.String columnName)
                         throws GSException
        指定された名前のカラムに対し、デフォルトの種別で名前のない索引を作成します。

        カラム名のみが設定されたIndexInfoを指定して createIndex(IndexInfo)を呼び出した場合と同様に振る舞います。

        Throws:
        GSException - 指定のカラム名がcreateIndex(IndexInfo)の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        GSException - 索引設定がサポートされていないカラムが指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • createIndex

        void createIndex(java.lang.String columnName,
                       IndexType type)
                         throws GSException
        指定された名前のカラムに対し、指定された種別で名前のない索引を作成します。

        カラム名と種別のみが設定されたIndexInfoを指定して createIndex(IndexInfo)を呼び出した場合と同様に振る舞います。

        Throws:
        GSException - 指定のカラム名と種別が createIndex(IndexInfo)の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        GSException - 指定のカラムにおいてサポートされていない索引種別が指定された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • createRow

        R createRow()
                    throws GSException
        このコンテナのカラムレイアウトに基づき、ロウオブジェクトを新規作成します。

        コンテナのロウオブジェクトの型がRowの場合、作成されるRowの各フィールドには GridStore.createRow(ContainerInfo)により作成した場合と同様に既定の初期値が設定されます。またこの場合、作成されたRowに対する操作は、このContainerオブジェクトのクローズ有無に影響しません。

        Throws:
        GSException - ユーザ定義型のロウオブジェクトを作成する場合に例外が送出された場合
        GSException - クローズ後に呼び出された場合
        Since:
        1.5
      • createTrigger

        void createTrigger(TriggerInfo info)
                           throws GSException
        トリガを設定します。

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

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

        トリガ種別

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

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

        このコンテナに対するロウ新規作成/更新 (put(Object)put(Object, Object)put(java.util.Collection)GridStore.multiPut(java.util.Map)RowSet.update(Object))・削除(remove(Object)RowSet.remove()) 操作命令の実行直後に通知を行います。監視対象として複数の操作が指定された場合は、そのうちのいずれかが実行された際に通知を行います。

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

        複数ロウ一括操作の場合、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("(カラム名)", (カラムデータ)) で設定されます。

        トリガが設定されているコンテナに対して GridStore.putCollection(String, Class, boolean)GridStore.putTimeSeries(String, Class, TimeSeriesProperties, boolean) などによりカラムレイアウトが変更された際に、トリガの通知対象となっているカラムの削除または名称変更があった場合、該当するカラムはトリガの通知対象から削除されます。

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

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

        Parameters:
        info - 設定対象のトリガ情報
        Throws:
        GSException - トリガ名がnull、または空の場合
        GSException - 監視対象更新操作の指定がない場合
        GSException - 通知先URIが規定の構文に合致しない場合
        GSException - トリガ種別でJMSが指定され、かつJMSデスティネーション種別がnull、または空、または指定の書式に合致しない場合
        GSException - トリガ種別でJMSが指定され、かつJMSデスティネーション名がnull、または空の場合
        GSException - この処理のタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
      • dropIndex

        void dropIndex(IndexInfo info)
                       throws GSException
        IndexInfoで設定されている内容に一致する、すべての索引を削除します。

        指定のIndexInfoにおいて、カラム名またはカラム番号の少なくとも一方が設定されている場合、指定のカラムに対する索引のみが削除対象となります。カラム名またはカラム番号は、対応するコンテナにおいて実在するカラムのものである必要があります。カラム名とカラム番号が共に指定されていた場合、対応するカラムが一致しなければなりません。カラム名ならびにカラム番号が共に設定されていない場合、他の条件を満たす任意のカラムに対する索引が削除対象となります。

        索引種別が設定されている場合、指定の種別の索引のみが削除対象となります。IndexType.DEFAULTが設定されていた場合、 createIndex(IndexInfo)の基準に従い、デフォルト種別の索引が選択されます。索引をサポートしていないカラムや指定の種別の索引をサポートしていないカラムが設定されていた場合、いずれの索引も削除対象にはなりません。索引種別が設定されていない場合、他の条件を満たす任意の種別の索引が削除対象となります。

        索引名が設定されている場合、指定の名前の索引のみが削除対象となります。索引名の同一性は、createIndex(IndexInfo)の基準に従います。索引名が設定されていない場合、任意の名前の索引ならびに名前のない索引が削除対象となります。

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

        トランザクションの扱いは、createIndex(IndexInfo)と同様です。また、複数の索引が削除対象となった場合に、一部の索引のみが削除された状態で他のトランザクションが実行されることがありうるかどうかは未定義です。

        索引の削除要求の完了直後の状態に関しては、 GridStore.dropContainer(String)と同様です。

        Throws:
        GSException - 削除対象のカラム、索引名が上記の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        GSException - 指定のカラムにおいてサポートされていない索引種別が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        3.5
      • dropIndex

        void dropIndex(java.lang.String columnName)
                       throws GSException
        指定された名前のカラムのうち、デフォルトの種別の索引のみを削除します。

        カラム名とデフォルトの種別が設定されたIndexInfoを指定して dropIndex(IndexInfo)を呼び出した場合と同様に振る舞います。

        Throws:
        GSException - 指定のカラム名がdropIndex(IndexInfo)の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • dropIndex

        void dropIndex(java.lang.String columnName,
                     IndexType type)
                       throws GSException
        指定された名前のカラムのうち、指定された種別の索引のみを削除します。

        カラム名と種別が設定されたIndexInfoを指定して dropIndex(IndexInfo)を呼び出した場合と同様に振る舞います。

        Throws:
        GSException - 指定のカラム名がdropIndex(IndexInfo)の規則に合致しない場合
        GSException - この処理のタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • dropTrigger

        void dropTrigger(java.lang.String name)
                         throws GSException
        トリガを削除します。

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

        Throws:
        GSException - この処理のタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
      • flush

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

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

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

        Throws:
        GSException - この処理のタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合
      • get

        R get(K key,
            boolean forUpdate)
              throws GSException
        指定のオプションに従い、ロウキーに対応するロウの内容を取得します。

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

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

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

        Parameters:
        forUpdate - 更新用ロックを要求するかどうか
        Returns:
        対応するロウオブジェクト。存在しない場合はnull
        Throws:
        GSException - ロウキーに対応するカラムが存在しない場合
        GSException - 自動コミットモードにもかかわらず、更新用ロックを要求しようとした場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーとして設定されていた場合
        java.lang.ClassCastException - 指定のロウキーがマッピング処理で使用されるロウキーの型と対応しない場合
        java.lang.NullPointerException - keynullが指定された場合
      • getType

        ContainerType getType()
                              throws GSException
        このコンテナの種別を取得します。

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

        Throws:
        GSException - クローズ後に呼び出された場合
        Since:
        1.5
      • put

        boolean put(java.util.Collection<R> rowCollection)
                    throws GSException
        指定のロウオブジェクト集合に基づき、任意個数のロウをまとめて新規作成または更新します。

        指定のロウオブジェクト集合の各ロウについて、イテレータからの取り出し順序に従ってput(Object)を呼び出した場合と同様に新規作成または更新操作を行います。

        指定のロウオブジェクト集合内に同一のロウキーを持つ複数のロウが存在する場合、ロウオブジェクト集合のイテレータからの取り出し順序を基準として、同一のロウキーを持つ最も後方にあるロウオブジェクトの内容が反映されます。

        コンテナの種別ならびに設定によっては、操作できるロウの内容について put(Object)と同様の制限が設けられています。具体的な制限事項は、サブインタフェースの定義を参照してください。

        バージョン1.1またはそれ以前のバージョンでは、指定のロウオブジェクト集合内のロウキーと同一の既存ロウが存在する場合や、指定のロウオブジェクト集合内に同一のロウキーを持つ複数のロウオブジェクトが存在する場合は使用できませんでした。

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

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

        Returns:
        現バージョンでは、常にfalse
        Throws:
        GSException - 特定コンテナ種別固有の制限に反する操作を行った場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がロウオブジェクトに含まれていた場合
        java.lang.ClassCastException - 指定の各ロウオブジェクトがマッピング処理で使用されるロウオブジェクトの型と対応しない場合
        java.lang.NullPointerException - rowCollectionまたはその要素として nullが指定された場合。また、put(Object, Object)と同様ロウオブジェクトの特定の箇所にnullが含まれていた場合
        See Also:
        put(Object)
      • put

        boolean put(K key,
                  R row)
                    throws GSException
        必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。

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

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

        コンテナの種別ならびに設定によっては、制限が設けられています。具体的な制限事項は、サブインタフェースの定義を参照してください。

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

        Parameters:
        key - 処理対象のロウキー
        row - 新規作成または更新するロウの内容と対応するロウオブジェクト
        Returns:
        指定のロウキーと一致するロウが存在したかどうか
        Throws:
        GSException - ロウキーに対応するカラムが存在しないにもかかわらず、キーが指定された場合
        GSException - 特定コンテナ固有の制限に反する操作を行った場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
        java.lang.ClassCastException - 指定のキーもしくはロウオブジェクトと、マッピング処理で使用される型との間で対応しないものがある場合
        java.lang.NullPointerException - rownullが指定された場合。また、ロウフィールドに対応するロウオブジェクト内のオブジェクトについて、NOT NULL制約があるにも関わらずnullが設定されている場合や、配列型の場合にnullの要素が含まれている場合
      • put

        boolean put(R row)
                    throws GSException
        常にロウオブジェクトのみを指定して、ロウを新規作成または更新します。

        指定のロウオブジェクト内のロウキーを使用する点を除き、 put(Object, Object)と同等です。

        Throws:
        GSException
        See Also:
        put(Object, Object)
      • query

        Query<R> query(java.lang.String tql)
                       throws GSException
        指定のTQL文を実行するためのクエリを作成します。

        選択式に集計演算を含むクエリなど、実行結果の出力形式がこのコンテナのロウの形式と対応しないクエリに対しては、使用できません。代わりに、query(String, Class)が利用できます。

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

        現バージョンでは、GSExceptionが送出されることはありません。

        Throws:
        java.lang.NullPointerException - tqlnullが指定された場合
        GSException
        See Also:
        query(String, Class)
      • query

        <S> Query<S> query(java.lang.String tql,
                         java.lang.Class<S> rowType)
                       throws GSException
        指定のTQL文・対応付け用クラスを使用する、クエリオブジェクトを作成します。

        集計演算のように、このコンテナのロウと異なる型の結果を期待する場合に使用します。

        rowTypeには次の型またはnullのみを指定できます。

        コンテナのロウの型
        query(String)と同様、このコンテナと対応する型のロウデータを受け取ります。
        AggregationResult
        集計演算の実行結果を受け取ります。
        QueryAnalysisEntry
        EXPLAIN文ならびEXPLAIN ANALYZE文の実行結果を受け取ります。
        null
        実行結果に応じた適切な型により結果を受け取ります。

        上記以外の値は指定できません。

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

        Throws:
        GSException - サポートされない型をrowTypeに指定した場合
        java.lang.NullPointerException - tqlnullが指定された場合
      • remove

        boolean remove(K key)
                       throws GSException
        指定のロウキーに対応するロウを削除します。

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

        コンテナの種別ならびに設定によっては、制限が設けられています。具体的な制限事項は、サブインタフェースの定義を参照してください。

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

        Returns:
        対応するロウが存在したかどうか
        Throws:
        GSException - ロウキーに対応するカラムが存在しない場合
        GSException - 特定コンテナ固有の制限に反する操作を行った場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーとして指定された場合
        java.lang.ClassCastException - 指定のロウキーがマッピング処理で使用されるロウキーの型と対応しない場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setAutoCommit

        void setAutoCommit(boolean enabled)
                           throws GSException
        コミットモードの設定を変更します。

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

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

        Throws:
        GSException - モード変更に伴いコミット処理を要求した際に、この処理またはトランザクションのタイムアウト、このコンテナの削除、接続障害が発生した場合、またはクローズ後に呼び出された場合

Class ContainerInfo

  • java.lang.Object
    • com.toshiba.mwcloud.gs.ContainerInfo


  • public class ContainerInfo
    extends java.lang.Object
    特定のコンテナに関する情報を表します。

    コンテナ名の表記、もしくは、コンテナ種別と時系列オプションの有無の対応などの内容の妥当性について、必ずしも検査するとは限りません。

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getColumnCount()
      カラム数を取得します。
      ColumnInfo getColumnInfo(int column)
      指定カラムに関する情報を取得します。
      java.lang.String getDataAffinity()
      データ配置最適化のために用いられる、コンテナ間の類似性を示す文字列を取得します。
      java.util.List<IndexInfo> getIndexInfoList()
      索引情報の一覧を取得します。
      java.lang.String getName()
      コンテナ名を取得します。
      TimeSeriesProperties getTimeSeriesProperties()
      時系列構成オプションを取得します。
      java.util.List<TriggerInfo> getTriggerInfoList()
      トリガ情報の一覧を取得します。
      ContainerType getType()
      コンテナの種別を取得します。
      boolean isColumnOrderIgnorable()
      カラム順序が無視できるかどうかを返します。
      boolean isRowKeyAssigned()
      ロウキーに対応するカラムの有無を取得します。
      void setColumnInfoList(java.util.List<ColumnInfo> columnInfoList)
      すべてのカラムの情報をまとめて設定します。
      void setColumnOrderIgnorable(boolean ignorable)
      カラム順序が無視できるかどうかを設定します。
      void setDataAffinity(java.lang.String dataAffinity)
      データ配置最適化のために用いられる、コンテナ間の類似性(データアフィニティ)を示す文字列を設定します。
      void setIndexInfoList(java.util.List<IndexInfo> indexInfoList)
      索引情報の一覧を設定します。
      void setName(java.lang.String name)
      コンテナ名を設定します。
      void setRowKeyAssigned(boolean assigned)
      ロウキーに対応するカラムの有無を設定します。
      void setTimeSeriesProperties(TimeSeriesProperties props)
      時系列構成オプションを設定します。
      void setTriggerInfoList(java.util.List<TriggerInfo> triggerInfoList)
      トリガ情報の一覧を設定します。
      void setType(ContainerType type)
      コンテナ種別を設定します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ContainerInfo

        public ContainerInfo()
        空のコンテナ情報を作成します。
        Since:
        1.5
      • ContainerInfo

        public ContainerInfo(ContainerInfo containerInfo)
        指定のコンテナ情報を複製します。
        Since:
        1.5
      • ContainerInfo

        public ContainerInfo(java.lang.String name,
                     ContainerType type,
                     java.util.List<ColumnInfo> columnInfoList,
                     boolean rowKeyAssigned)
    • Method Detail

      • getColumnCount

        public int getColumnCount()
        カラム数を取得します。
        Returns:
        カラム数。カラムレイアウト未設定の場合は0
      • getColumnInfo

        public ColumnInfo getColumnInfo(int column)
        指定カラムに関する情報を取得します。
        Parameters:
        column - カラムを特定するための番号。0以上かつカラム数未満の値
        Returns:
        指定カラム番号に対応するカラム情報
        Throws:
        java.lang.IllegalArgumentException - 範囲外のカラム番号を指定した場合
        See Also:
        RowField.columnNumber()
      • getDataAffinity

        public java.lang.String getDataAffinity()
        データ配置最適化のために用いられる、コンテナ間の類似性を示す文字列を取得します。
        Returns:
        時系列間の類似性を示す文字列。標準設定の場合はnull
        Since:
        2.1
        See Also:
        setDataAffinity(String)
      • getIndexInfoList

        public java.util.List<IndexInfo> getIndexInfoList()
        索引情報の一覧を取得します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Returns:
        索引情報の一覧
        Since:
        3.5
      • getName

        public java.lang.String getName()
        コンテナ名を取得します。
        Returns:
        コンテナ名。未設定の場合はnull
      • getTimeSeriesProperties

        public TimeSeriesProperties getTimeSeriesProperties()
        時系列構成オプションを取得します。

        返却されたオブジェクトの内容を呼び出し後に変更した場合に、このオブジェクトの内容が変化するかどうかは未定義です。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化するかどうかは未定義です。

        Returns:
        時系列構成オプション。未設定の場合はnull
        Since:
        1.5
      • getTriggerInfoList

        public java.util.List<TriggerInfo> getTriggerInfoList()
        トリガ情報の一覧を取得します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Returns:
        トリガ情報の一覧
        Since:
        1.5
      • getType

        public ContainerType getType()
        コンテナの種別を取得します。
        Returns:
        コンテナの種別。未設定の場合はnull
        See Also:
        ContainerType
      • isColumnOrderIgnorable

        public boolean isColumnOrderIgnorable()
        カラム順序が無視できるかどうかを返します。
        Returns:
        カラム順序が無視できるか
        Since:
        1.5
      • isRowKeyAssigned

        public boolean isRowKeyAssigned()
        ロウキーに対応するカラムの有無を取得します。

        コンテナがロウキーを持つ場合、対応するカラム番号は0です。

        Returns:
        ロウキーの有無
      • setColumnInfoList

        public void setColumnInfoList(java.util.List<ColumnInfo> columnInfoList)
        すべてのカラムの情報をまとめて設定します。

        カラム順序を無視しない場合、指定のカラム情報の並びが実際のコンテナのカラムの並びと対応します。

        ロウキーに対応するカラムの有無の設定状態によらず、設定を解除することができます。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        columnInfoList - カラム情報のリスト。nullまたは空のリスト場合、設定が解除される
        Since:
        1.5
        See Also:
        setColumnOrderIgnorable(boolean)
      • setColumnOrderIgnorable

        public void setColumnOrderIgnorable(boolean ignorable)
        カラム順序が無視できるかどうかを設定します。

        デフォルトでは無視しない(false)状態に設定されています。

        Parameters:
        ignorable - カラム順序が無視できるか
        Since:
        1.5
        See Also:
        GridStore.putContainer(String, ContainerInfo, boolean)
      • setDataAffinity

        public void setDataAffinity(java.lang.String dataAffinity)
        データ配置最適化のために用いられる、コンテナ間の類似性(データアフィニティ)を示す文字列を設定します。

        同一クラスタノード上の同一管理領域内に格納されるコンテナについて、配置先を最適化するために使用されます。

        類似性設定が同一のコンテナの内容は、近接する配置先に格納される可能性が高くなります。また、解放期限が設定され、近接する配置先に格納された時系列について、登録頻度などの変更パターンが類似している場合、解放期限に到達したロウの解放処理が効率的に行われる可能性が高くなります。

        空文字列は指定できません。また、使用できる文字種はコンテナ名と同様のものに制限されます。文字列の長さの上限については GridDBテクニカルリファレンスを参照してください。長さの上限を超えるコンテナを作成することはできません。

        Parameters:
        dataAffinity - コンテナ間の類似性を示す文字列。nullが指定された場合は標準設定を優先することを示す。規則に合致しない文字列は指定できない
        Throws:
        java.lang.IllegalArgumentException - 指定の文字列が正しい形式ではない場合。ただし、文字列の最大長を超えたとしても例外が発生するとは限らない
        Since:
        2.1
      • setIndexInfoList

        public void setIndexInfoList(java.util.List<IndexInfo> indexInfoList)
        索引情報の一覧を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        indexInfoList - 索引情報の一覧。nullまたは空のリスト場合、設定が解除される
        Since:
        3.5
      • setName

        public void setName(java.lang.String name)
        コンテナ名を設定します。
        Parameters:
        name - コンテナ名。nullの場合、設定が解除される
        Since:
        1.5
      • setRowKeyAssigned

        public void setRowKeyAssigned(boolean assigned)
        ロウキーに対応するカラムの有無を設定します。

        デフォルトではロウキーなしに設定されています。

        カラムレイアウトの設定状態によらず使用できます。

        Parameters:
        assigned - ロウキーに対応するカラムの有無。ロウキーを持つ場合は true、持たない場合はfalse
        Since:
        1.5
      • setTimeSeriesProperties

        public void setTimeSeriesProperties(TimeSeriesProperties props)
        時系列構成オプションを設定します。

        コンテナ種別の設定状態によらず使用できます。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        props - 時系列構成オプション。nullの場合、設定が解除される
        Since:
        1.5
      • setTriggerInfoList

        public void setTriggerInfoList(java.util.List<TriggerInfo> triggerInfoList)
        トリガ情報の一覧を設定します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        triggerInfoList - トリガ情報のリスト。nullまたは空のリスト場合、設定が解除される
        Since:
        1.5
      • setType

        public void setType(ContainerType type)
        コンテナ種別を設定します。
        Parameters:
        type - コンテナ種別。nullの場合、設定が解除される
        Since:
        1.5

Enum ContainerType

  • java.lang.Object
    • java.lang.Enum<ContainerType>
      • com.toshiba.mwcloud.gs.ContainerType
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ContainerType>


    public enum ContainerType
    extends java.lang.Enum<ContainerType>
    コンテナの種別を表します。
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      COLLECTION
      対象のコンテナがコレクションであることを示します。
      TIME_SERIES
      対象のコンテナが時系列であることを示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static ContainerType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ContainerType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • COLLECTION

        public static final ContainerType COLLECTION
        対象のコンテナがコレクションであることを示します。
      • TIME_SERIES

        public static final ContainerType TIME_SERIES
        対象のコンテナが時系列であることを示します。
    • Method Detail

      • valueOf

        public static ContainerType valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static ContainerType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ContainerType c : ContainerType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Enum FetchOption

  • java.lang.Object
    • java.lang.Enum<FetchOption>
      • com.toshiba.mwcloud.gs.FetchOption
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FetchOption>


    public enum FetchOption
    extends java.lang.Enum<FetchOption>
    クエリ実行結果を取得する際のオプション項目です。
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      LIMIT
      取得するロウの数の最大値を設定するために使用します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static FetchOption valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FetchOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • LIMIT

        public static final FetchOption LIMIT
        取得するロウの数の最大値を設定するために使用します。

        実行結果のロウ数が最大値を超えた場合、RowSetで得られる順番で先頭から最大値の分だけが取得できます。それ以降のロウは取得できません。

        サポートされる設定値の型は、IntegerまたはLongです。負の値は指定できません。設定が省略された場合、上限は設定されません。

    • Method Detail

      • valueOf

        public static FetchOption valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static FetchOption[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (FetchOption c : FetchOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Class GSException

  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • java.io.IOException
          • com.toshiba.mwcloud.gs.GSException
  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    GSTimeoutException


    public class GSException
    extends java.io.IOException
    GridDB機能の処理中に発生した例外状態を示します。
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      GSException() 
      GSException(int errorCode, java.lang.String description) 
      GSException(int errorCode, java.lang.String errorName, java.lang.String description, java.lang.Throwable cause) 
      GSException(int errorCode, java.lang.String description, java.lang.Throwable cause) 
      GSException(int errorCode, java.lang.Throwable cause) 
      GSException(java.lang.String message) 
      GSException(java.lang.String message, java.lang.Throwable cause) 
      GSException(java.lang.Throwable cause) 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getErrorCode()
      エラー番号を取得します。
      java.lang.String getMessage() 
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • GSException

        public GSException()
      • GSException

        public GSException(int errorCode,
                   java.lang.String description)
      • GSException

        public GSException(int errorCode,
                   java.lang.String errorName,
                   java.lang.String description,
                   java.lang.Throwable cause)
      • GSException

        public GSException(int errorCode,
                   java.lang.String description,
                   java.lang.Throwable cause)
      • GSException

        public GSException(int errorCode,
                   java.lang.Throwable cause)
      • GSException

        public GSException(java.lang.String message)
      • GSException

        public GSException(java.lang.String message,
                   java.lang.Throwable cause)
      • GSException

        public GSException(java.lang.Throwable cause)
    • Method Detail

      • getErrorCode

        public int getErrorCode()
        エラー番号を取得します。

        対応する番号が存在しない場合は0を返します。

      • getMessage

        public java.lang.String getMessage()
        Overrides:
        getMessage in class java.lang.Throwable

Class GSTimeoutException

  • All Implemented Interfaces:
    java.io.Serializable


    public class GSTimeoutException
    extends GSException
    要求した処理が既定の時間内に終了しなかったことを示す例外です。
    Since:
    1.5
    See Also:
    Serialized Form
    • Method Summary

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • GSTimeoutException

        public GSTimeoutException()
      • GSTimeoutException

        public GSTimeoutException(int errorCode,
                          java.lang.String description)
      • GSTimeoutException

        public GSTimeoutException(int errorCode,
                          java.lang.String errorName,
                          java.lang.String description,
                          java.lang.Throwable cause)
      • GSTimeoutException

        public GSTimeoutException(int errorCode,
                          java.lang.String description,
                          java.lang.Throwable cause)
      • GSTimeoutException

        public GSTimeoutException(int errorCode,
                          java.lang.Throwable cause)
      • GSTimeoutException

        public GSTimeoutException(java.lang.String message)
      • GSTimeoutException

        public GSTimeoutException(java.lang.String message,
                          java.lang.Throwable cause)
      • GSTimeoutException

        public GSTimeoutException(java.lang.Throwable cause)
  • java.lang.Object
    • java.lang.Enum<GSType>
      • com.toshiba.mwcloud.gs.GSType
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GSType>


    public enum GSType
    extends java.lang.Enum<GSType>
    GridDB上のフィールド値の型を表します。
    • Enum Constant Detail

      • BLOB

        public static final GSType BLOB
      • BOOL

        public static final GSType BOOL
      • BOOL_ARRAY

        public static final GSType BOOL_ARRAY
      • BYTE

        public static final GSType BYTE
      • BYTE_ARRAY

        public static final GSType BYTE_ARRAY
      • DOUBLE

        public static final GSType DOUBLE
      • DOUBLE_ARRAY

        public static final GSType DOUBLE_ARRAY
      • FLOAT

        public static final GSType FLOAT
      • FLOAT_ARRAY

        public static final GSType FLOAT_ARRAY
      • GEOMETRY

        public static final GSType GEOMETRY
      • INTEGER

        public static final GSType INTEGER
      • INTEGER_ARRAY

        public static final GSType INTEGER_ARRAY
      • LONG

        public static final GSType LONG
      • LONG_ARRAY

        public static final GSType LONG_ARRAY
      • SHORT

        public static final GSType SHORT
      • SHORT_ARRAY

        public static final GSType SHORT_ARRAY
      • STRING

        public static final GSType STRING
      • STRING_ARRAY

        public static final GSType STRING_ARRAY
      • TIMESTAMP

        public static final GSType TIMESTAMP
      • TIMESTAMP_ARRAY

        public static final GSType TIMESTAMP_ARRAY
    • Method Detail

      • valueOf

        public static GSType valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static GSType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (GSType c : GSType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Class Geometry

  • java.lang.Object
    • com.toshiba.mwcloud.gs.Geometry


  • public class Geometry
    extends java.lang.Object
    2次元、もしくは3次元の空間範囲を示すジオメトリデータを管理します。

    このクラスのインスタンスは不変です。また、このクラスのインスタンスに対するメソッド呼び出しはスレッド安全です。

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      このオブジェクトと他のオブジェクトが等しいかどうかを示します。
      int hashCode()
      このオブジェクトのハッシュコード値を返します。
      java.lang.String toString()
      WKT(Well-Known Text)形式による文字列表現(WKT表現)を返します。
      static Geometry valueOf(java.lang.String value)
      WKT(Well-Known Text)形式によるジオメトリデータの文字列表現(WKT表現)から Geometryを作成します。
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • equals

        public boolean equals(java.lang.Object obj)
        このオブジェクトと他のオブジェクトが等しいかどうかを示します。

        valueOf(String)により生成したオブジェクトについて、生成元のWKT表現が文字列として互いに等価ではない場合であっても、区切り文字としての空白文字の有無やデフォルト値のSRID表記の有無といった表記の揺れ以外の違いがない場合は等価であるとみなされます。たとえば、次の3つのWKT表現より生成されるオブジェクトは、等価であるとみなされます。

         POLYGON((0 0,10 0,10 10,0 10,0 0))
         POLYGON( (0 0,10 0,10 10,0 10,0 0) )
         POLYGON((0 0,10 0,10 10,0 10,0 0);-1)

        一方、領域を構成する閉じた線の始点・終点位置が異なるなどして、 WKT表現が文字列として等価になりえないものの同一の空間領域を指すオブジェクトは、等価ではないとみなされます。たとえば、次の2つのWKT表現より生成されるオブジェクトは、等価ではないとみなされます。

         POLYGON((0 0,10 0,10 10,0 10,0 0))
         POLYGON((0 10,0 0,10 0,10 10,0 10))

        このメソッドは、Object.hashCode()にて定義されている汎用規約に準拠します。したがって、等価なオブジェクトは等価なハッシュコードを保持します。

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - 比較対象の参照オブジェクト
        Returns:
        このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse
        See Also:
        hashCode()
      • hashCode

        public int hashCode()
        このオブジェクトのハッシュコード値を返します。

        このメソッドは、Object.hashCode()にて定義されている汎用規約に準拠します。したがって、等価なオブジェクトのハッシュコード値は等価です。

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        このオブジェクトのハッシュコード値
        See Also:
        equals(Object)
      • toString

        public java.lang.String toString()
        WKT(Well-Known Text)形式による文字列表現(WKT表現)を返します。

        返却される文字列は、区切り文字としての空白文字の有無やデフォルト値のSRID表記の有無といった表記の揺れによっては、 valueOf(String)により生成した際に指定したWKT表現と比べて等価ではない文字列となる場合があります。

        Overrides:
        toString in class java.lang.Object
      • valueOf

        public static Geometry valueOf(java.lang.String value)
                                throws java.lang.IllegalArgumentException
        WKT(Well-Known Text)形式によるジオメトリデータの文字列表現(WKT表現)から Geometryを作成します。

        サポート対象のWKT表現は、TQLのST_GeomFromText関数が扱う表現範囲と同一です。ただし、空間構造QUADRATICSURFACEはコンテナに格納することはできず、検索条件としてのみ使用できます。

        Parameters:
        value - 生成対象のWKT表現
        Returns:
        WKT表現より生成されたGeometryインスタンス
        Throws:
        java.lang.IllegalArgumentException - 指定の文字列がWKT形式と一致しない場合

Enum GeometryOperator

  • java.lang.Object
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GeometryOperator>


    public enum GeometryOperator
    extends java.lang.Enum<GeometryOperator>
    空間範囲同士の関係性についての制約を定義します。

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      INTERSECT
      双方の空間範囲またはその外接構造が交差する関係にあることを示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static GeometryOperator valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GeometryOperator[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • INTERSECT

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

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

    • Method Detail

      • valueOf

        public static GeometryOperator valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static GeometryOperator[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (GeometryOperator c : GeometryOperator.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Interface GridStore

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable


    public interface GridStore
    extends java.io.Closeable
    接続したGridDBシステム内のデータベースに属するデータを操作するための機能を提供します。

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

    時系列、コレクションといったコンテナ種別に関係なく、重複した名前で格納することはできません。コンテナ名はベースコンテナ名の後ろに必要に応じてノードアフィニティ名をアットマーク「@」で連結した形で指定できます。ベースコンテナ名、ノードアフィニティ名に使用できる文字は、ASCIIの英数字とアンダースコア(「_」)のみです。 ASCIIの大文字と小文字は同一視されます。ベースコンテナ名の先頭に数字を使用できません。コンテナ名の長さの上限については、GridDBテクニカルリファレンスを参照してください。

    各メソッドのスレッド安全性は保証されません。

    See Also:
    Collection, TimeSeries, Container
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。
      Row createRow(ContainerInfo info)
      ContainerInfoを指定して、Rowを新規作成します。
      void dropCollection(java.lang.String name)
      指定の名前を持つコレクションを削除します。
      void dropContainer(java.lang.String name)
      指定の名前を持つコンテナを削除します。
      void dropTimeSeries(java.lang.String name)
      指定の名前を持つ時系列を削除します。
      void fetchAll(java.util.List<? extends Query<?>> queryList)
      指定された任意個数のQueryについて、可能な限りリクエスト単位を大きくしてクエリ実行とフェッチを行います。
      <K> Collection<K,Row> getCollection(java.lang.String name)
      Rowによりロウ操作できるCollectionオブジェクトを取得します。
      <K,R> Collection<K,R> getCollection(java.lang.String name, java.lang.Class<R> rowType)
      指定の名前のコレクションを操作するためのCollectionオブジェクトを取得します。
      <K> Container<K,Row> getContainer(java.lang.String name)
      Rowによりロウ操作できるContainerオブジェクトを取得します。
      ContainerInfo getContainerInfo(java.lang.String name)
      指定の名前のコンテナに関する情報を取得します。
      PartitionController getPartitionController()
      対応するGridDBクラスタについてのPartitionControllerを取得します。
      TimeSeries<Row> getTimeSeries(java.lang.String name)
      Rowによりロウ操作できるTimeSeriesオブジェクトを取得します。
      <R> TimeSeries<R> getTimeSeries(java.lang.String name, java.lang.Class<R> rowType)
      指定の名前の時系列を操作するためのTimeSeriesオブジェクトを取得します。
      java.util.Map<java.lang.String,java.util.List<Row>> multiGet(java.util.Map<java.lang.String,? extends RowKeyPredicate<?>> containerPredicateMap)
      指定の条件に基づき、任意のコンテナの任意個数・範囲のロウについて、可能な限りリクエスト単位を大きくして取得します。
      void multiPut(java.util.Map<java.lang.String,java.util.List<Row>> containerRowsMap)
      任意のコンテナの任意個数のロウについて、可能な限りリクエスト単位を大きくして新規作成または更新操作を行います。
      <K,R> Collection<K,R> putCollection(java.lang.String name, java.lang.Class<R> rowType)
      コレクションを新規作成または変更します。
      <K,R> Collection<K,R> putCollection(java.lang.String name, java.lang.Class<R> rowType, boolean modifiable)
      変更オプションを指定して、コレクションを新規作成または変更します。
      <K> Collection<K,Row> putCollection(java.lang.String name, ContainerInfo info, boolean modifiable)
      ContainerInfoを指定して、コレクションを新規作成または変更します。
      <K,R> Container<K,R> putContainer(java.lang.String name, java.lang.Class<R> rowType, ContainerInfo info, boolean modifiable)
      ロウオブジェクトの型とContainerInfoを指定して、コンテナを新規作成または変更します。
      <K> Container<K,Row> putContainer(java.lang.String name, ContainerInfo info, boolean modifiable)
      ContainerInfoを指定して、コンテナを新規作成または変更します。
      <R> TimeSeries<R> putTimeSeries(java.lang.String name, java.lang.Class<R> rowType)
      時系列を新規作成または変更します。
      <R> TimeSeries<R> putTimeSeries(java.lang.String name, java.lang.Class<R> rowType, TimeSeriesProperties props, boolean modifiable)
      追加設定や変更オプションを指定して、時系列を新規作成または変更します。
      TimeSeries<Row> putTimeSeries(java.lang.String name, ContainerInfo info, boolean modifiable)
      ContainerInfoを指定して、時系列を新規作成または変更します。
    • Method Detail

      • close

        void close()
                   throws GSException
        GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。

        GSExceptionが送出された場合であっても、接続状態は解除やローカルのリソース解放は適宜実施されます。ただし、GridDB上のトランザクション状態などは残る可能性があります。すでにクローズ済みの場合、このメソッドを呼び出しても何の効果もありません。

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        GSException - 接続障害が発生した場合
      • createRow

        Row createRow(ContainerInfo info)
                      throws GSException
        ContainerInfoを指定して、Rowを新規作成します。

        Containerにて規定された制約に合致するよう、 ColumnInfoのリストならびにロウキーの有無を含むカラムレイアウトをContainerInfoに指定します。

        また、コンテナ種別をContainerInfoに含めることで、特定のコンテナ種別固有の制約に合致するかどうかを検証できます。ただし、作成されたRowに対してRow.getSchema() を呼び出したとしても、コンテナ種別は含まれません。

        作成されたRowの各フィールドには、Containerにて定義されている空の値が初期値として設定されます。

        作成されたRowに対する操作は、このGridStoreオブジェクトのクローズ有無に影響しません。

        Parameters:
        info - カラムレイアウトを含むコンテナ情報。その他の内容は無視される
        Returns:
        作成されたRow
        Throws:
        GSException - コンテナ種別もしくはカラムレイアウトの制約に合致しない場合
        GSException - クローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
        See Also:
        Container
      • dropCollection

        void dropCollection(java.lang.String name)
                            throws GSException
        指定の名前を持つコレクションを削除します。

        削除済みの場合の扱い、トランザクションの扱い、削除要求完了直後の状態に関しては、dropContainer(String)と同様です。

        Parameters:
        name - 処理対象のコレクションの名前
        Throws:
        GSException - 種別の異なるコンテナを削除しようとした場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • dropContainer

        void dropContainer(java.lang.String name)
                           throws GSException
        指定の名前を持つコンテナを削除します。

        削除済みの場合は何も変更しません。

        処理対象のコンテナにおいて実行中のトランザクションが存在する場合、それらの終了を待機してから削除を行います。

        コンテナの削除要求が完了した直後は、削除した索引のために使用されていたメモリやストレージ領域を他の用途にただちに再利用できない場合があります。また、削除処理に関連した処理がクラスタ上で動作することにより、削除前と比べて負荷が高まる期間が一定程度継続する場合があります。現バージョンでは、カラムレイアウトの変更時などと異なり、削除開始から終了までの間に固有の、他の参照操作を許容しつつ変更操作で待機が発生する状態が発生することはありません。

        Parameters:
        name - 処理対象のコンテナの名前
        Throws:
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
        See Also:
        dropCollection(String), dropTimeSeries(String)
      • dropTimeSeries

        void dropTimeSeries(java.lang.String name)
                            throws GSException
        指定の名前を持つ時系列を削除します。

        削除済みの場合の扱い、トランザクションの扱い、削除要求完了直後の状態に関しては、dropContainer(String)と同様です。

        Parameters:
        name - 処理対象の時系列の名前
        Throws:
        GSException - 種別の異なるコンテナを削除しようとした場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • fetchAll

        void fetchAll(java.util.List<? extends Query<?>> queryList)
                      throws GSException
        指定された任意個数のQueryについて、可能な限りリクエスト単位を大きくしてクエリ実行とフェッチを行います。

        指定のリストに含まれる各Queryに対して、個別にQuery.fetch() を行った場合と同様にクエリ実行とフェッチを行い、結果のRowSetを設定します。各Queryの実行結果を取り出すには、Query.getRowSet() を使用します。ただし、個別に行う場合と違い、同一の格納先などの可能な限り大きな単位で対象ノードに対しリクエストしようとします。これにより、リストの要素数が多くなるほど、対象ノードとやりとりする回数が削減される可能性が高くなります。リスト内のQueryの実行順序は不定です。

        指定のリストには、このGridStoreオブジェクトを介して得られた、対応するContainerを含めクローズされていないQuery のみを含めることができます。 Query.fetch()と同様、各Queryが持つ最後に生成された RowSetがクローズされます。同一のインスタンスがリストに複数含まれていた場合、それぞれ異なるインスタンスであった場合と同様に振る舞います。

        他のコンテナ・ロウ操作と同様、異なるコンテナ間での整合性は保証されません。したがって、あるコンテナに対する処理の結果は、その処理の開始前に完了した他の操作命令の影響を受けることがあります。

        指定のQueryに対応する各Containerのコミットモードが自動コミットモード、手動コミットモードのいずれであったとしても、使用できます。トランザクション状態はクエリの実行結果に反映されます。正常に操作が完了した場合、トランザクションタイムアウト時間に到達しない限り、対応する各Containerのトランザクションをアボートすることはありません。

        Queryに対する処理の途中で例外が発生した場合、一部のQueryについてのみ新たなRowSet が設定されることがあります。また、指定のQueryに対応する各Containerの未コミットのトランザクションについては、アボートされることがあります。

        一度に大量のロウを取得しようとした場合、GridDBノードが管理する通信バッファのサイズの上限に到達し、失敗することがあります。上限サイズについては、GridDBテクニカルリファレンスを参照してください。

        Parameters:
        queryList - 対象とするQueryのリスト
        Throws:
        GSException - このGridStoreオブジェクトを介して得られた Query以外のQueryが含まれていた場合
        GSException - 正しくないパラメータ・構文・命令を含むクエリを実行しようとした場合。たとえば、TQLでは、関数の引数に対応しない型のカラムを指定した場合。具体的な制約は、このクエリを作成する機能の各種定義を参照のこと
        GSException - TQLを実行した際、実行結果が期待する結果 RowSetの各要素の型と合致しない場合
        GSException - この処理または関連するトランザクションのタイムアウト、対応するコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、または対応するコンテナのクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数queryListnullが指定された場合、または、引数queryListの要素としてnullが含まれていた場合
        java.lang.NullPointerException - このクエリを作成する際に与えられたパラメータの中に、許容されないnullが含まれていた場合。GridDB上で実行される TQL文の評価処理の結果として送出されることはない
        Since:
        1.5
        See Also:
        Query.fetch()
      • getCollection

        <K> Collection<K,Row> getCollection(java.lang.String name)
                                        throws GSException
        Rowによりロウ操作できるCollectionオブジェクトを取得します。

        期待するコンテナ種別がContainerType.COLLECTIONに限定され、返却される型がCollectionとなる点を除き、 getContainer(String)と同様に振る舞います。

        Returns:
        コレクションが存在する場合は対応するCollection、存在しない場合はnull
        Throws:
        GSException - 同名の時系列が存在する場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
        See Also:
        getContainer(String)
      • getCollection

        <K,R> Collection<K,R> getCollection(java.lang.String name,
                                          java.lang.Class<R> rowType)
                                      throws GSException
        指定の名前のコレクションを操作するためのCollectionオブジェクトを取得します。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        Parameters:
        name - 処理対象のコレクションの名前
        rowType - 処理対象のコレクションのカラムレイアウトと対応するロウオブジェクトの型
        Returns:
        コレクションが存在する場合は対応するCollection、存在しない場合はnull
        Throws:
        GSException - 同名の時系列が存在する場合
        GSException - 指定の型と既存のカラムレイアウトが一致しない場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • getContainer

        <K> Container<K,Row> getContainer(java.lang.String name)
                                      throws GSException
        Rowによりロウ操作できるContainerオブジェクトを取得します。

        次の点を除き、getCollection(String, Class) もしくはgetTimeSeries(String, Class)と同様に振る舞います。

        • 既存のコンテナの種別ならびにカラムレイアウトに基づきContainer オブジェクトを返却する
        • コンテナの種別ならびにカラムレイアウトを指定しないため、これらの不一致に伴うエラーが発生しない
        • 返却されるContainerのロウオブジェクトの型が常にRowとなる

        それぞれの同名の引数nameの用法ついても同様です。

        Parameters:
        name - 処理対象のコンテナの名前
        Returns:
        コンテナが存在する場合は対応するContainer、存在しない場合はnull。コンテナが存在し、種別が ContainerType.COLLECTIONであった場合はCollectionContainerType.TIME_SERIESであった場合はTimeSeriesのインスタンスとなる。
        Throws:
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
        See Also:
        getCollection(String, Class), getTimeSeries(String, Class)
      • getContainerInfo

        ContainerInfo getContainerInfo(java.lang.String name)
                                       throws GSException
        指定の名前のコンテナに関する情報を取得します。

        返却されるContainerInfoに含まれるコンテナ名は、GridDB上に格納されているものが設定されます。したがって、指定したコンテナ名と比較すると、 ASCII大文字・小文字の表記が異なる場合があります。

        カラム順序を無視するかどうかについては、無視しない状態に設定されます。この設定は、ContainerInfo.isColumnOrderIgnorable()を通じて確認できます。

        Parameters:
        name - 処理対象のコンテナの名前
        Returns:
        指定の名前のコンテナに関する情報
        Throws:
        GSException - GSExceptionこの処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • getTimeSeries

        TimeSeries<Row> getTimeSeries(java.lang.String name)
                                      throws GSException
        Rowによりロウ操作できるTimeSeriesオブジェクトを取得します。

        期待するコンテナ種別がContainerType.TIME_SERIESに限定され、返却される型がTimeSeriesとなる点を除き、 getTimeSeries(String)と同様に振る舞います。

        Returns:
        時系列が存在する場合は対応するTimeSeries、存在しない場合はnull
        Throws:
        GSException - 同名のコレクションが存在する場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        Since:
        1.5
        See Also:
        getContainer(String)
      • getTimeSeries

        <R> TimeSeries<R> getTimeSeries(java.lang.String name,
                                      java.lang.Class<R> rowType)
                                    throws GSException
        指定の名前の時系列を操作するためのTimeSeriesオブジェクトを取得します。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        Parameters:
        name - 処理対象の時系列の名前
        rowType - 処理対象の時系列のカラムレイアウトと対応するロウオブジェクトの型
        Returns:
        時系列が存在する場合は対応するTimeSeries、存在しない場合はnull
        Throws:
        GSException - 同名のコレクションが存在する場合
        GSException - 指定の型と既存のカラムレイアウトが一致しない場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • multiGet

        java.util.Map<java.lang.String,java.util.List<Row>> multiGet(java.util.Map<java.lang.String,? extends RowKeyPredicate<?>> containerPredicateMap)
                                                                     throws GSException
        指定の条件に基づき、任意のコンテナの任意個数・範囲のロウについて、可能な限りリクエスト単位を大きくして取得します。

        指定のマップに含まれる条件に従い、個別にContainer.get(Object) もしくはQuery.fetch()を呼び出した場合と同様に、ロウの内容を取得します。ただし、個別に行う場合と違い、同一の格納先などの可能な限り大きな単位で対象ノードに対しリクエストしようとします。これにより、対象コンテナの総数や条件に合致するロウの総数が多くなるほど、対象ノードとやりとりする回数が削減される可能性が高くなります。

        指定のマップは、コンテナ名をキー、RowKeyPredicateで表現される取得条件を値とする任意個数のエントリから構成されます。同一のRowKeyPredicateインスタンスを複数含めることもできます。また、対象とするコンテナとして、コンテナ種別やカラムレイアウトが異なるものを混在させることができます。ただし、コンテナの構成によっては評価できない取得条件が存在します。具体的な制限については、RowKeyPredicateに対する各種設定機能の定義を参照してください。また、指定のコンテナ名は、実在するコンテナのものでなければなりません。マップのキーまたは値としてnullを含めることはできません。

        返却されるマップは、コンテナ名をキー、ロウオブジェクトのリストを値とするエントリにより構成されます。返却されるマップには、取得条件として指定したマップに含まれるすべてのコンテナ名が含まれます。同一のコンテナを指し大文字小文字表記の異なるコンテナ名の設定された複数のエントリが指定のマップに含まれていた場合、返却されるマップにはこれらを1つにまとめたエントリが格納されます。同一のリストに複数のロウオブジェクトが含まれる場合、格納される順序はコンテナ種別と対応するContainerのサブインタフェースの定義に従います。指定のコンテナに対応するロウが1つも存在しない場合、対応するロウオブジェクトのリストは空になります。

        返却されたマップもしくはマップに含まれるリストに対して変更操作を行った場合に、 UnsupportedOperationExceptionなどの実行時例外が発生するかどうかは未定義です。

        他のコンテナ・ロウ操作と同様、異なるコンテナ間での整合性は保証されません。したがって、あるコンテナに対する処理の結果は、その処理の開始前に完了した他の操作命令の影響を受けることがあります。

        Container.get(Object, boolean)もしくは Query.fetch(boolean)のように、トランザクションを維持し、更新用ロックを要求することはできません。

        一度に大量のロウを取得しようとした場合、GridDBノードが管理する通信バッファのサイズの上限に到達し、失敗することがあります。上限サイズについては、GridDBテクニカルリファレンスを参照してください。

        Parameters:
        containerPredicateMap - 対象とするコンテナの名前と条件からなるマップ
        Returns:
        条件に合致するロウ集合をコンテナ別に保持するマップ
        Throws:
        GSException - 対象とするコンテナが存在しない場合。また、指定のコンテナに関して評価できない取得条件が指定された場合
        GSException - この処理またはトランザクションのタイムアウト、接続障害が発生した場合、クローズ後に呼び出された場合
        java.lang.NullPointerException - 引数containerPredicateMapとして nullが指定された場合、このマップのキーまたは値としてnullが含まれていた場合
        Since:
        1.5
        See Also:
        Container.get(Object), Query.fetch(), RowKeyPredicate
      • multiPut

        void multiPut(java.util.Map<java.lang.String,java.util.List<Row>> containerRowsMap)
                      throws GSException
        任意のコンテナの任意個数のロウについて、可能な限りリクエスト単位を大きくして新規作成または更新操作を行います。

        指定のマップに含まれる各ロウオブジェクトについて、個別に Container.put(Object)を呼び出した場合と同様に新規作成または更新操作を行います。ただし、個別に行う場合と違い、同一の格納先などの可能な限り大きな単位で対象ノードに対しリクエストしようとします。これにより、対象コンテナの総数や指定のロウオブジェクトの総数が多くなるほど、対象ノードとやりとりする回数が削減される可能性が高くなります。

        指定のマップは、コンテナ名をキー、ロウオブジェクトのリストを値とする任意個数のエントリから構成されます。対象とするコンテナとして、コンテナ種別やカラムレイアウトが異なるものを混在させることができます。ただし、すでに存在するコンテナでなければなりません。マップのキーまたは値としてnullを含めることはできません。

        各ロウオブジェクトのリストには、対象のコンテナと同一のカラムレイアウトの Rowのみを任意個数含めることができます。現バージョンでは、カラム順序についてもすべて同一でなければなりません。リストの要素としてnullを含めることはできません。

        コンテナの種別ならびに設定によっては、操作できるロウの内容について Container.put(Object)と同様の制限が設けられています。具体的な制限事項は、Containerのサブインタフェースの定義を参照してください。

        指定のマップ内に同一コンテナを対象とした同一ロウキーを持つ複数のロウオブジェクトが存在する場合、異なるリスト間であればマップエントリ集合のイテレータからの取り出し順、同一リスト内であればリストの要素順を基準として、同値のロウキーを持つ最も後方にあるロウオブジェクトの内容が反映されます。

        トランザクションを維持し、ロックを保持し続けることはできません。ただし、既存のトランザクションが対象ロウに影響するロックを確保している場合、すべてのロックが解放されるまで待機し続けます。

        他のコンテナ・ロウ操作と同様、異なるコンテナ間での整合性は保証されません。したがって、あるコンテナに対する処理の結果は、その処理の開始前に完了した他の操作命令の影響を受けることがあります。

        各コンテナならびにロウに対する処理の途中で例外が発生した場合、一部のコンテナの一部のロウに対する操作結果のみが反映されたままとなることがあります。

        Parameters:
        containerRowsMap - 対象とするコンテナの名前とロウオブジェクトのリストからなるマップ
        Throws:
        GSException - 対象とするコンテナが存在しない場合、また、対象とするコンテナとロウオブジェクトとのカラムレイアウトが一致しない場合
        GSException - 特定コンテナ種別固有の制限に反する操作を行った場合
        GSException - この処理またはトランザクションのタイムアウト、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がロウオブジェクトに含まれていた場合
        java.lang.NullPointerException - 引数containerRowsMapとして nullが指定された場合、このマップのキーまたは値としてnullが含まれていた場合、もしくは、マップを構成するリストの要素としてnullが含まれていた場合
        Since:
        1.5
        See Also:
        Container.put(Object)
      • putCollection

        <K,R> Collection<K,R> putCollection(java.lang.String name,
                                          java.lang.Class<R> rowType)
                                      throws GSException
        コレクションを新規作成または変更します。

        同名のコンテナが存在しない場合、指定のクラスにより定義されたカラムレイアウトに従い、新規にコレクションを作成します。すでに同名のコンテナが存在し、既存のカラムレイアウトの内容がすべて一致する場合、実行中のトランザクションを待機する点を除き getCollection(String, Class)と同様に振る舞います。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        すでに同名のコレクションが存在し、かつ、該当するコレクションにおいて実行中のトランザクションが存在する場合、それらの終了を待機してから処理を行います。

        Parameters:
        name - 処理対象のコレクションの名前
        rowType - 処理対象のコレクションのカラムレイアウトと対応するロウオブジェクトの型
        Returns:
        対応するCollection
        Throws:
        GSException - 同名のコレクションが存在する場合。または、既存の同名の時系列に関してカラムレイアウトならびに追加設定の内容が一致しない場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • putCollection

        <K,R> Collection<K,R> putCollection(java.lang.String name,
                                          java.lang.Class<R> rowType,
                                          boolean modifiable)
                                      throws GSException
        変更オプションを指定して、コレクションを新規作成または変更します。

        同名のコンテナが存在しない場合、指定のクラスにより定義されたカラムレイアウトに従い、新規にコレクションを作成します。すでに同名のコレクションが存在し、既存のカラムレイアウトの内容がすべて一致する場合、実行中のトランザクションを待機する点を除き getCollection(String, Class)と同様に振る舞います。

        modifiabletrueであり、すでに同名のコレクションが存在する場合、必要に応じカラムレイアウトを変更します。変更する際、要求したカラムと同一の名前・型の既存のカラムは保持されます。一致しないカラムのうち、既存のコレクションにない名前のカラムは追加し、要求側にないカラムはデータも含め削除します。型が異なる同名のカラムが存在する場合は失敗します。また、ロウキーに対応するカラムの追加と削除はできません。

        コンテナにトリガが設定されており、カラムレイアウト変更によってトリガが通知対象としているカラムが削除された場合、そのカラムはトリガの通知対象から削除されます。

        新たに追加されるカラムの値は、Containerにて定義されている空の値を初期値として初期化されます。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        すでに同名のコレクションが存在し、かつ、該当するコレクションにおいて実行中のトランザクションが存在する場合、それらの終了を待機してから処理を行います。

        ロウキーを持つコレクションを新規に作成する場合、ロウキーに対し、 Container.createIndex(String)にて定義されているデフォルト種別の索引が作成されます。この索引は、削除することができます。

        バージョン1.1またはそれ以前のバージョンでは、新規に作成された時点での索引作成は行われませんでした。

        現バージョンでは、コンテナの規模など諸条件を満たした場合、カラムレイアウトの変更開始から終了までの間に、処理対象のコンテナに対してコンテナ情報の参照、更新ロックなしでのロウの参照操作を行える場合があります。それ以外の操作は、Containerでの説明通り待機させる場合があります。カラムレイアウトの変更途中に別の操作が行われる場合は、変更前のカラムレイアウトが使用されます。

        Parameters:
        name - 処理対象のコレクションの名前
        rowType - 処理対象のコレクションのカラムレイアウトと対応するロウオブジェクトの型
        modifiable - 既存コレクションのカラムレイアウト変更を許可するかどうか
        Returns:
        対応するCollection
        Throws:
        GSException - 同名の時系列が存在する場合。または、modifiablefalseであり、既存の同名のコレクションに関してカラムレイアウトの内容が一致しない場合や、 modifiabletrueであり、既存の同名のコレクションに関して変更できない項目を変更しようとした場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • putContainer

        <K,R> Container<K,R> putContainer(java.lang.String name,
                                        java.lang.Class<R> rowType,
                                        ContainerInfo info,
                                        boolean modifiable)
                                    throws GSException
        ロウオブジェクトの型とContainerInfoを指定して、コンテナを新規作成または変更します。

        主に、ロウオブジェクトの型を指定して、追加設定を持つコンテナを新規作成する場合に使用します。

        カラムレイアウトならびにカラム順序の無視設定をContainerInfoに指定できない点を除けば、 putContainer(String, ContainerInfo, boolean)と同様です。

        Parameters:
        name - 処理対象のコンテナの名前
        rowType - 処理対象のコレクションのカラムレイアウトと対応するロウオブジェクトの型
        info - 処理対象のコンテナの情報。nullの場合は無視される
        modifiable - 既存コンテナのカラムレイアウト変更を許可するかどうか
        Returns:
        対応するContainer。コンテナ種別として ContainerType.COLLECTIONを指定した場合はCollectionContainerType.TIME_SERIESを指定した場合はTimeSeriesのインスタンスとなる。
        Throws:
        GSException - nameならびにinfo引数の内容が規則に合致しない場合。また、指定のコンテナ種別に対応するコンテナ新規作成・変更メソッドの規則に合致しない場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - rowType引数にnullが指定された場合
        Since:
        2.1
        See Also:
        putContainer(String, ContainerInfo, boolean), putCollection(String, Class, boolean), putTimeSeries(String, Class, TimeSeriesProperties, boolean)
      • putContainer

        <K> Container<K,Row> putContainer(java.lang.String name,
                                        ContainerInfo info,
                                        boolean modifiable)
                                      throws GSException
        ContainerInfoを指定して、コンテナを新規作成または変更します。

        次の点を除き、putCollection(String, Class, boolean) もしくはputTimeSeries(String, Class, TimeSeriesProperties, boolean) と同様に振る舞います。

        • ContainerInfoを用いてコンテナ種別、カラムレイアウト、ならびに、必要に応じ時系列構成オプションを指定する
        • 返却されるContainerのロウオブジェクトの型が常にRowとなる

        それぞれの同名の引数modifiableの用法ついても同様です。

        コンテナに関する情報の指定方法の一覧は次の通りです。

        項目引数説明
        コンテナ名nameまたはinfo 少なくともいずれかの引数にnullではない値を指定する。両方に指定する場合、異なる値を指定してはならない。
        コンテナ種別info nullではない値を指定する。 ContainerType.COLLECTIONを指定した場合、 putCollection(String, Class, boolean)と同様の振る舞いとなる。 ContainerType.TIME_SERIESを指定した場合、 putTimeSeries(String, Class, TimeSeriesProperties, boolean)と同様の振る舞いとなる。
        カラムレイアウトinfo Containerにて規定された制約に合致するよう ColumnInfoのリストならびにロウキーの有無を設定する。
        カラム順序の無視info 無視する場合、同名の既存のコンテナのカラム順序と一致するかどうかを検証しない。
        時系列構成オプションinfo コンテナ種別がContainerType.TIME_SERIESの場合のみ、 nullではない値を指定できる。
        索引設定info 現バージョンでは無視される。今後のバージョンでは、 Container.createIndex(String, IndexType)の規則に合致しない設定が含まれていた場合、例外が送出される可能性がある。
        トリガ設定info 現バージョンでは無視される。今後のバージョンでは、 Container.createTrigger(TriggerInfo)の規則に合致しない設定が含まれていた場合、例外が送出される可能性がある。
        コンテナ類似性info null以外を指定し新規作成する場合、指定の内容が反映される。既存コンテナの設定を変更することはできない。nullを指定した場合は無視される。
        Parameters:
        name - 処理対象のコンテナの名前
        info - 処理対象のコンテナの情報
        modifiable - 既存コンテナのカラムレイアウト変更を許可するかどうか
        Returns:
        対応するContainer。コンテナ種別として ContainerType.COLLECTIONを指定した場合はCollectionContainerType.TIME_SERIESを指定した場合はTimeSeriesのインスタンスとなる。
        Throws:
        GSException - nameならびにinfo引数の内容が規則に合致しない場合。また、指定のコンテナ種別に対応するコンテナ新規作成・変更メソッドの規則に合致しない場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - info引数にnullが指定された場合
        Since:
        1.5
        See Also:
        putCollection(String, Class, boolean), putTimeSeries(String, Class, TimeSeriesProperties, boolean), Container
      • putTimeSeries

        <R> TimeSeries<R> putTimeSeries(java.lang.String name,
                                      java.lang.Class<R> rowType)
                                    throws GSException
        時系列を新規作成または変更します。

        同名のコンテナが存在しない場合、指定のクラスにより定義されたカラムレイアウトに従い、新規に時系列を作成します。すでに同名の時系列が存在し、既存のカラムレイアウトの内容がすべて一致する場合、実行中のトランザクションを待機する点を除き getTimeSeries(String, Class)と同様に振る舞います。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        すでに同名の時系列が存在し、かつ、該当する時系列において実行中のトランザクションが存在する場合、それらの終了を待機してから処理を行います。

        Parameters:
        name - 処理対象の時系列の名前
        rowType - 処理対象の時系列のカラムレイアウトと対応するロウオブジェクトの型
        Returns:
        対応するTimeSeries
        Throws:
        GSException - 同名のコレクションが存在する場合。または、既存の同名の時系列に関してカラムレイアウトならびに追加設定の内容が一致しない場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
      • putTimeSeries

        <R> TimeSeries<R> putTimeSeries(java.lang.String name,
                                      java.lang.Class<R> rowType,
                                      TimeSeriesProperties props,
                                      boolean modifiable)
                                    throws GSException
        追加設定や変更オプションを指定して、時系列を新規作成または変更します。

        同名のコンテナが存在しない場合、指定のクラスにより定義されたカラムレイアウトや追加設定に従い、新規に時系列を作成します。すでに同名の時系列が存在し、既存のカラムレイアウトならびに追加設定の内容がすべて一致する場合、実行中のトランザクションを待機する点を除き getTimeSeries(String, Class)と同様に振る舞います。

        modifiabletrueであり、すでに同名の時系列が存在する場合、必要に応じカラムレイアウトを変更します。変更する際、要求したカラムと同一の名前・型の既存のカラムは保持されます。一致しないカラムのうち、既存の時系列にない名前のカラムは追加し、要求側にないカラムはデータも含め削除します。型が異なる同名のカラムが存在する場合は失敗します。また、ロウキーに対応するカラムの追加と削除、時系列構成オプションの変更はできません。時系列構成オプションを指定する場合は、既存の設定内容とすべて同値にする必要があります。

        コンテナにトリガが設定されており、カラムレイアウト変更によってトリガが通知対象としているカラムが削除された場合、そのカラムはトリガの通知対象から削除されます。

        新たに追加されるカラムの初期値については、 putCollection(String, Class, boolean)の定義を参照してください。

        指定の型とカラムレイアウトとの対応関係については、Containerの定義を参照してください。

        すでに同名の時系列が存在し、かつ、該当する時系列において実行中のトランザクションが存在する場合、それらの終了を待機してから処理を行います。

        Parameters:
        name - 処理対象の時系列の名前
        rowType - 処理対象の時系列のカラムレイアウトと対応するロウオブジェクトの型
        props - 時系列の構成オプション。nullを指定すると、同名の時系列が存在する場合は既存の設定が継承され、存在しない場合は初期状態のTimeSeriesPropertiesを指定したものとみなされる。
        modifiable - 既存時系列のカラムレイアウト変更を許可するかどうか
        Returns:
        対応するTimeSeries
        Throws:
        GSException - 同名のコレクションが存在する場合。または、modifiablefalseであり、既存の同名の時系列に関してカラムレイアウトならびに追加設定の内容が一致しない場合や、 modifiabletrueであり、既存の同名の時系列に関して変更できない項目を変更しようとした場合
        GSException - 指定の型がロウオブジェクトの型として適切でない場合。詳しくはContainerの定義を参照
        GSException - この処理のタイムアウト、接続障害が発生した場合、またはクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合

Class GridStoreFactory

  • java.lang.Object
    • com.toshiba.mwcloud.gs.GridStoreFactory
  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable


    public abstract class GridStoreFactory
    extends java.lang.Object
    implements java.io.Closeable
    GridStoreインスタンスを管理します。

    GridStoreインスタンス共通のクライアント設定や使用済みのコネクションを管理します。

    GridDBにアクセスするためには、このファクトリを介して GridStoreインスタンスを取得する必要があります。

    このクラスの公開メソッドは、すべてスレッド安全です。

    また、クライアントロギングとクライアント設定ファイルの機能を使用できます。

    クライアントロギング

    クラスパスにロギングライブラリを含めることで、ログ出力を有効にした場合にログを出力できます。

    ロギングフレームワークはSLF4Jを使用します。ロガーの名称は「com.toshiba.mwcloud.gs.GridStoreLogger」で始まります。また、SLF4Jのバージョンは1.6.0以上を推奨しています。

    クライアント設定ファイル

    設定ファイル「gs_client.properties」を含むディレクトリと、設定ライブラリ「gridstore-conf.jar」をクラスパスに共に含めることで、GridStoreFactoryに設定ファイルの内容を適用することができます。設定ファイルを用いることで、アプリケーションコードを修正せずに、接続設定を変更できます。設定ファイルには以下のPropertiesオブジェクトと同じプロパティ項目を指定できます。設定ファイルの内容はPropertiesオブジェクトの設定より優先的に適用されます。

    factoryカテゴリプロパティ
    有効なプロパティの項目はsetProperties(Properties)の仕様に準拠します。
    以下のように「factory.」をプロパティ名の前に付けて記述します。
    factory.maxConnectionPoolSize = 10
    storeカテゴリプロパティ
    有効なプロパティの項目はgetGridStore(Properties)の仕様に準拠します。
    以下のように「store.」をプロパティ名の前に付けて記述します。
    store.clusterName = Project1

    以下の場合は例外が発生します。

    • 設定ファイルを含む複数のディレクトリがクラスパスに含まれる場合
    • 設定ライブラリのみがクラスパスに含まれる場合
    • 存在しないカテゴリ名が指定された場合
    • プロパティ名がカテゴリ名のみからなる場合

    また、設定ファイルを含むディレクトリのみがクラスパスに含まれ、設定ライブラリがクラスパスに含まれない場合には、設定ファイルの内容は適用されません。

    • Constructor Summary

      Constructors 
      Modifier Constructor and Description
      protected GridStoreFactory() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      abstract void close()
      このファクトリより作成されたGridStoreをすべてクローズし、必要に応じて関連するリソースを解放します。
      abstract GridStore getGridStore(java.util.Properties properties)
      指定のプロパティを持つGridStoreを取得します。
      static GridStoreFactory getInstance()
      デフォルトのインスタンスを取得します。
      abstract void setProperties(java.util.Properties properties)
      このファクトリの設定を変更します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GridStoreFactory

        protected GridStoreFactory()
    • Method Detail

      • close

        public abstract void close()
                            throws GSException
        このファクトリより作成されたGridStoreをすべてクローズし、必要に応じて関連するリソースを解放します。

        GSExceptionが送出された場合でも、関連するコネクションリソースはすべて解放されます。すでにクローズ済みの場合、このメソッドを呼び出しても何の効果もありません。なお、現在のVMの終了時にも呼び出されます。

        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface java.lang.AutoCloseable
        Throws:
        GSException - クローズ処理中に接続障害などが発生した場合
        See Also:
        Closeable.close()
      • getGridStore

        public abstract GridStore getGridStore(java.util.Properties properties)
                                        throws GSException
        指定のプロパティを持つGridStoreを取得します。

        GridStoreを取得した時点では、各Containerを管理するマスタノード(以下、マスタ)のアドレス探索を必要に応じて行うだけであり、認証処理は行われません。実際に各Containerに対応するノードに接続する必要が生じたタイミングで、認証処理が行われます。

        以下のプロパティを指定できます。サポート外の名称のプロパティは無視されます。一部プロパティに設けられている機能上の上限値については、 GridDBテクニカルリファレンスを参照してください。

        名称説明
        host接続先ホスト名。IPアドレス(IPV4のみ)も可。マスタを手動指定する場合は必須。マスタを自動検出する場合は設定しない
        port接続先ポート番号。0から 65535までの数値の文字列表現。マスタを手動指定する場合は必須。マスタを自動検出する場合は設定しない
        notificationAddressマスタ自動検出に用いられる通知情報を受信するためのIPアドレス(IPV4のみ)。省略時はデフォルトのアドレスを使用。 notificationMemberおよびnotificationProviderと同時に指定することはできない
        notificationPortマスタ自動検出に用いられる通知情報を受信するためのポート番号。0から65535までの数値の文字列表現。省略時はデフォルトのポートを使用
        clusterNameクラスタ名。接続先のクラスタに設定されているクラスタ名と一致するかどうかを確認するために使用される。省略時もしくは空文字列を指定した場合、クラスタ名の確認は行われない。クラスタ名の長さには機能上の上限があり、上限を超えた場合、任意のクラスタノードへの接続に失敗する
        database接続先のデータベース名。省略時は全てのユーザがアクセス可能な「public」データベースに自動接続される。接続ユーザは接続データベースに属するコンテナを操作できる。
        userユーザ名
        passwordユーザ認証用のパスワード
        consistency次のいずれかの一貫性レベル。
        "IMMEDIATE"
        他のクライアントからの更新結果は、該当トランザクションの完了後即座に反映される
        "EVENTUAL"
        他のクライアントからの更新結果は、該当トランザクションが完了した後でも反映されない場合がある。 Containerに対する更新操作は実行できない
        デフォルトでは"IMMEDIATE"が適用されます
        transactionTimeoutトランザクションタイムアウト時間の最低値。関係するContainerにおける各トランザクションの開始時点から適用。 0以上Integer.MAX_VALUEまでの値の文字列表現であり、単位は秒。ただし、タイムアウト時間として有効に機能する範囲に上限があり、上限を超える指定は上限値が指定されたものとみなされる。 0の場合、後続のトランザクション処理がタイムアウトエラーになるかどうかは常に不定となる。省略時は接続先GridDB上のデフォルト値を使用
        failoverTimeoutフェイルオーバ処理にて新たな接続先が見つかるまで待機する時間の最低値。0以上 Integer.MAX_VALUEまでの数値の文字列表現であり、単位は秒。 0の場合、フェイルオーバ処理を行わない。省略時はこのファクトリの設定値を使用
        containerCacheSize コンテナキャッシュに格納するコンテナ情報の最大個数。 0以上Integer.MAX_VALUEまでの数値の文字列表現。値が0の場合、コンテナキャッシュを使用しないことを意味する。 Containerを取得する際にキャッシュにヒットした場合は、 GridDBへのコンテナ情報の問い合わせを行わない。省略時は既存の設定値を使用。バージョン1.5よりサポート
        dataAffinityPattern データアフィニティ機能のアフィニティ文字列を次のようにコンテナパターンとペアで任意個数指定できる。
        (コンテナ名パターン1)=(アフィニティ文字列1),(コンテナ名パターン2)=(アフィニティ文字列2),...
        ContainerInfo.setDataAffinity(String)が未指定のContainerを追加する際に、コンテナ名が指定したいずれかのコンテナ名パターンに合致する場合に、ペアで指定したアフィニティ文字列が適用される。複数のコンテナ名パターンが合致する場合は、記述された順番で最初に合致したパターンが用いられる。コンテナ名パターンは大文字小文字を同一視する点とワイルドカード「%」を使用できる他は、コンテナ名の規則に準拠する。アフィニティ文字列はContainerInfo.setDataAffinity(String)の規則に準拠する。バージョン2.7よりサポート
        notificationMember 固定リスト方式を使用して構成されたクラスタに接続する場合に、クラスタノードのアドレス・ポートのリストを次のように指定する。
        (アドレス1):(ポート1),(アドレス2):(ポート2),...
        notificationAddressおよびnotificationProviderと同時に指定することはできない。バージョン2.9よりサポート
        notificationProvider プロバイダ方式を使用して構成されたクラスタに接続する場合に、アドレスプロバイダのURLを指定する。 notificationAddressおよびnotificationMemberと同時に指定することはできない。バージョン2.9よりサポート

        取得のたびに、新たなGridStoreインスタンスが生成されます。異なるGridStoreインスタンスならびに関連するオブジェクトに対する操作は、スレッド安全です。すなわち、ある2つのオブジェクトがそれぞれGridStore インスタンスを基にして生成されたものまたはGridStoreインスタンスそのものであり、かつ、該当する関連GridStoreインスタンスが異なる場合、一方のオブジェクトに対してどのスレッドからどのタイミングでメソッドが呼び出されていたとしても、他方のオブジェクトのメソッドを呼び出すことができます。ただし、GridStore自体のスレッド安全性は保証されていないため、同一GridStoreインスタンスに対して複数スレッドから任意のタイミングでメソッド呼び出しすることはできません。

        Parameters:
        properties - 取得設定を指示するためのプロパティ
        Throws:
        GSException - 指定のホストについて名前解決できなかった場合
        GSException - プロパティ指定時、指定のプロパティが上で説明した形式に合致しない場合。形式に合致している場合は、接続や認証できない値であっても例外は送出されない
        GSException - すでにクローズ済みの場合
        java.lang.NullPointerException - propertiesnullが指定された場合
      • getInstance

        public static GridStoreFactory getInstance()
        デフォルトのインスタンスを取得します。

        このクラスのロード時に、GridStoreFactoryクラスのデフォルトのサブクラスがロードされ、インスタンスが生成されます。

      • setProperties

        public abstract void setProperties(java.util.Properties properties)
                                    throws GSException
        このファクトリの設定を変更します。

        設定の変更は、このファクトリより生成されたGridStore、ならびに、今後このファクトリで生成されるGridStoreに反映されます。

        以下のプロパティを指定できます。サポート外の名称のプロパティは無視されます。

        名称説明
        maxConnectionPoolSize内部で使用されるコネクションプールの最大コネクション数。0以上 Integer.MAX_VALUEまでの数値の文字列表現。値が0の場合、コネクションプールを使用しないことを意味する。省略時は既存の設定値を使用
        failoverTimeout フェイルオーバ処理にて新たな接続先が見つかるまで待機する時間の最低値。0以上 Integer.MAX_VALUEまでの数値の文字列表現であり、単位は秒。 0の場合、フェイルオーバ処理を行わない。省略時は既存の設定値を使用
        Throws:
        GSException - 指定のプロパティが上で説明した形式に合致しない場合
        GSException - すでにクローズ済みの場合
        java.lang.NullPointerException - propertiesnullが指定された場合

Class IndexInfo

  • java.lang.Object
    • com.toshiba.mwcloud.gs.IndexInfo


  • public class IndexInfo
    extends java.lang.Object
    索引の設定内容を表します。

    カラム名の表記やカラム番号の妥当性について、必ずしも検査するとは限りません。

    Since:
    3.5
    • Constructor Summary

      Constructors 
      Constructor and Description
      IndexInfo()
      空の索引情報を作成します。
      IndexInfo(IndexInfo info)
      指定の内容を引き継ぎ、新たな索引情報を作成します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static IndexInfo createByColumn(java.lang.String columnName, IndexType type)
      必要に応じカラム名と索引種別を指定して索引情報を作成します。
      static IndexInfo createByName(java.lang.String name, IndexType type)
      必要に応じ索引名と索引種別を指定して索引情報を作成します。
      java.lang.Integer getColumn()
      索引に対応するカラムのカラム番号を取得します。
      java.lang.String getColumnName()
      索引に対応するカラムのカラム名を取得します。
      java.lang.String getName()
      索引名を取得します。
      IndexType getType()
      索引種別を取得します。
      void setColumn(java.lang.Integer column)
      索引に対応するカラムのカラム番号を設定します。
      void setColumnName(java.lang.String columnName)
      索引に対応するカラムのカラム名を設定します。
      void setName(java.lang.String name)
      索引名を設定します。
      void setType(IndexType type)
      索引種別を設定します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • IndexInfo

        public IndexInfo()
        空の索引情報を作成します。

        索引種別、索引名、カラム番号、カラム名がいずれも未設定の状態の索引情報を作成します。

      • IndexInfo

        public IndexInfo(IndexInfo info)
        指定の内容を引き継ぎ、新たな索引情報を作成します。
        Parameters:
        info - 引き継ぎ対象の索引情報
        Throws:
        java.lang.NullPointerException - 引数にnullが指定された場合
    • Method Detail

      • createByColumn

        public static IndexInfo createByColumn(java.lang.String columnName,
                               IndexType type)
        必要に応じカラム名と索引種別を指定して索引情報を作成します。
        Parameters:
        columnName - カラム名。指定しない場合はnull
        type - 索引種別。指定しない場合はnull
      • createByName

        public static IndexInfo createByName(java.lang.String name,
                             IndexType type)
        必要に応じ索引名と索引種別を指定して索引情報を作成します。
        Parameters:
        name - 索引名。指定しない場合はnull
        type - 索引種別。指定しない場合はnull
      • getColumn

        public java.lang.Integer getColumn()
        索引に対応するカラムのカラム番号を取得します。
        Returns:
        カラム番号。未設定の場合はnull
      • getColumnName

        public java.lang.String getColumnName()
        索引に対応するカラムのカラム名を取得します。
        Returns:
        カラム名。未設定の場合はnull
      • getName

        public java.lang.String getName()
        索引名を取得します。
        Returns:
        索引名。未設定の場合はnull
      • getType

        public IndexType getType()
        索引種別を取得します。
        Returns:
        索引種別。未設定の場合はnull
      • setColumn

        public void setColumn(java.lang.Integer column)
        索引に対応するカラムのカラム番号を設定します。
        Parameters:
        column - 索引名。nullの場合は未設定状態になる
      • setColumnName

        public void setColumnName(java.lang.String columnName)
        索引に対応するカラムのカラム名を設定します。
        Parameters:
        columnName - カラム名。nullの場合は未設定状態になる
      • setName

        public void setName(java.lang.String name)
        索引名を設定します。
        Parameters:
        name - 索引名。nullの場合は未設定状態になる
      • setType

        public void setType(IndexType type)
        索引種別を設定します。
        Parameters:
        type - 索引種別。nullの場合は未設定状態になる

Enum IndexType

  • java.lang.Object
    • java.lang.Enum<IndexType>
      • com.toshiba.mwcloud.gs.IndexType
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IndexType>


    public enum IndexType
    extends java.lang.Enum<IndexType>
    Containerに設定する索引の種別を示します。
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      DEFAULT
      デフォルトの索引種別を示します。
      HASH
      ハッシュ索引を示します。
      SPATIAL
      空間索引を示します。
      TREE
      ツリー索引を示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static IndexType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IndexType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • DEFAULT

        public static final IndexType DEFAULT
        デフォルトの索引種別を示します。

        この種別は、特定の種別を明示せずに索引の操作を行う必要がある場合に用いられるものであり、実在する索引はこの種別以外の種別に分類されます。

        Since:
        3.5
      • HASH

        public static final IndexType HASH
        ハッシュ索引を示します。

        この索引は、Collectionにおける次の型のカラムに対して設定できます。

        • STRING
        • BOOL
        • BYTE
        • SHORT
        • INTEGER
        • LONG
        • FLOAT
        • DOUBLE
        • TIMESTAMP

        TimeSeriesに対して設定することはできません。

      • SPATIAL

        public static final IndexType SPATIAL
        空間索引を示します。

        この索引は、CollectionにおけるGEOMETRY型のカラムに対してのみ使用できます。TimeSeriesに対して設定することはできません。

        バージョン1.1またはそれ以前のバージョンでは、使用できませんでした。

      • TREE

        public static final IndexType TREE
        ツリー索引を示します。

        この索引は、時系列におけるロウキーと対応するカラムを除く、任意種別のコンテナにおける次の型のカラムに対して使用できます。

        • STRING
        • BOOL
        • BYTE
        • SHORT
        • INTEGER
        • LONG
        • FLOAT
        • DOUBLE
        • TIMESTAMP
    • Method Detail

      • valueOf

        public static IndexType valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static IndexType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (IndexType c : IndexType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Enum InterpolationMode

  • java.lang.Object
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InterpolationMode>


    public enum InterpolationMode
    extends java.lang.Enum<InterpolationMode>
    ロウの補間方法の種別を表します。

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      EMPTY
      空の値を補間値として用いることを示します。
      LINEAR_OR_PREVIOUS
      カラムに応じて線形補間または直前ロウの値による補間を行うことを示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static InterpolationMode valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InterpolationMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • EMPTY

        public static final InterpolationMode EMPTY
        空の値を補間値として用いることを示します。

        ロウキーを除くすべてのロウフィールドについて、Containerにて定義されている空の値を補間値として用いることを示します。

      • LINEAR_OR_PREVIOUS

        public static final InterpolationMode LINEAR_OR_PREVIOUS
        カラムに応じて線形補間または直前ロウの値による補間を行うことを示します。

        補間機能にて指定されたカラムについては、補間対象時刻の前後時刻のロウの値により線形補間を行います。対象とするカラムの型は数値型でなければなりません。

        補間機能にて特に指定されていないカラムについては、補間対象時刻と隣接する直前の時刻のロウの値を補間値として使用します。対象とするカラムの型に制限はありません。

    • Method Detail

      • valueOf

        public static InterpolationMode valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static InterpolationMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (InterpolationMode c : InterpolationMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Annotation Type NotNull



  • @Retention(value=RUNTIME)
    @Target(value={TYPE,FIELD,METHOD,PACKAGE})
    public @interface NotNull
    NOT NULL制約を持つカラムであることを示します。
    Since:
    3.5
    See Also:
    Container

Annotation Type Nullable



  • @Retention(value=RUNTIME)
    @Target(value={TYPE,FIELD,METHOD,PACKAGE})
    public @interface Nullable
    NOT NULL制約を持たないカラムであることを示します。
    Since:
    3.5
    See Also:
    Container

Interface PartitionController

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable


    public interface PartitionController
    extends java.io.Closeable
    パーティション状態の取得や操作のためのコントローラです。

    パーティションとは、データを格納する論理的な領域です。 GridDBクラスタ内のデータ配置に基づいた操作を行うために使用します。

    Since:
    1.5
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void assignPreferableHost(int partitionIndex, java.net.InetAddress host)
      優先的に選択されるホストのアドレスを設定します。
      void close()
      GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。
      java.util.List<java.net.InetAddress> getBackupHosts(int partitionIndex)
      指定のパーティションに対応するバックアップノードのアドレス一覧を取得します。
      long getContainerCount(int partitionIndex)
      指定のパーティションに属するコンテナの総数を取得します。
      java.util.List<java.lang.String> getContainerNames(int partitionIndex, long start, java.lang.Long limit)
      指定のパーティションに所属するコンテナの名前の一覧を取得します。
      java.util.List<java.net.InetAddress> getHosts(int partitionIndex)
      指定のパーティションに対応するノードのアドレス一覧を取得します。
      java.net.InetAddress getOwnerHost(int partitionIndex)
      指定のパーティションに対応するオーナノードのアドレスを取得します。
      int getPartitionCount()
      対象とするGridDBクラスタのパーティション数を取得します。
      int getPartitionIndexOfContainer(java.lang.String containerName)
      指定のコンテナ名に対応するパーティションインデックスを取得します。
    • Method Detail

      • assignPreferableHost

        void assignPreferableHost(int partitionIndex,
                                java.net.InetAddress host)
                                  throws GSException
        優先的に選択されるホストのアドレスを設定します。

        バックアップノードへの接続など、可能な接続先が複数存在する場合に、設定されたアドレスが候補に含まれていれば常に選択されるようになります。それ以外の場合は設定が無視されます。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        host - 優先的に選択されるホストのアドレス。nullの場合、設定が解除される
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
        See Also:
        getBackupHosts(int)
      • close

        void close()
                   throws GSException
        GridDBとの接続状態を解除し、必要に応じて関連するリソースを解放します。
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        GSException - 現バージョンでは送出されない
      • getBackupHosts

        java.util.List<java.net.InetAddress> getBackupHosts(int partitionIndex)
                                                            throws GSException
        指定のパーティションに対応するバックアップノードのアドレス一覧を取得します。

        バックアップノードとは、 GridStoreFactory.getGridStore(java.util.Properties)における一貫性レベルとして"EVENTUAL"を指定した場合に、優先的に選択されるノードのことです。

        一覧の順序に関しては不定です。重複するアドレスが含まれることはありません。

        返却されたリストに対して変更操作を行った場合に、 UnsupportedOperationExceptionなどの実行時例外が発生するかどうかは未定義です。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        Returns:
        バックアップノードのアドレスを表すInetAddressを要素とする、List
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
      • getContainerCount

        long getContainerCount(int partitionIndex)
                               throws GSException
        指定のパーティションに属するコンテナの総数を取得します。

        コンテナ数を求める際の計算量は、コンテナ数にはおおむね依存しません。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        Returns:
        コンテナ数
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
        See Also:
        getPartitionIndexOfContainer(String)
      • getContainerNames

        java.util.List<java.lang.String> getContainerNames(int partitionIndex,
                                                         long start,
                                                         java.lang.Long limit)
                                                           throws GSException
        指定のパーティションに所属するコンテナの名前の一覧を取得します。

        指定のパーティションについてコンテナの新規作成・構成変更・削除が行われたとしても、該当コンテナを除くとその前後で一覧の取得結果の順序が変わることはありません。それ以外の一覧の順序に関しては不定です。重複する名前が含まれることはありません。

        取得件数の上限が指定された場合、上限を超える場合、後方のものから切り捨てられます。指定条件に該当するものが存在しない場合、空のリストが返却されます。

        返却されたリストに対して変更操作を行った場合に、 UnsupportedOperationExceptionなどの実行時例外が発生するかどうかは未定義です。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        start - 取得範囲の開始位置。0以上の値
        limit - 取得件数の上限。nullの場合、上限なしとみなされる
        Returns:
        コンテナの名前を要素とするList
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
      • getHosts

        java.util.List<java.net.InetAddress> getHosts(int partitionIndex)
                                                      throws GSException
        指定のパーティションに対応するノードのアドレス一覧を取得します。

        一覧の順序に関しては不定です。重複するアドレスが含まれることはありません。

        返却されたリストに対して変更操作を行った場合に、 UnsupportedOperationExceptionなどの実行時例外が発生するかどうかは未定義です。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        Returns:
        ノードのアドレスを表すInetAddressを要素とする、List
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
      • getOwnerHost

        java.net.InetAddress getOwnerHost(int partitionIndex)
                                          throws GSException
        指定のパーティションに対応するオーナノードのアドレスを取得します。

        オーナノードとは、 GridStoreFactory.getGridStore(java.util.Properties)における一貫性レベルとして"IMMEDIATE"を指定した場合に、常に選択されるノードのことです。

        Parameters:
        partitionIndex - パーティションインデックス。0以上パーティション数未満の値
        Returns:
        オーナノードのアドレスを表すInetAddress
        Throws:
        GSException - 範囲外のパーティションインデックスが指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
      • getPartitionCount

        int getPartitionCount()
                              throws GSException
        対象とするGridDBクラスタのパーティション数を取得します。

        対象とするGridDBクラスタにおけるパーティション数設定の値を取得します。一度取得した結果はキャッシュされ、次にクラスタ障害・クラスタノード障害を検知するまで再びGridDBクラスタに問い合わせることはありません。

        Returns:
        パーティション数
        Throws:
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
      • getPartitionIndexOfContainer

        int getPartitionIndexOfContainer(java.lang.String containerName)
                                         throws GSException
        指定のコンテナ名に対応するパーティションインデックスを取得します。

        一度GridDBクラスタが構築されると、コンテナの所属先のパーティションが変化することはなく、パーティションインデックスも一定となります。指定の名前に対応するコンテナが存在するかどうかは、結果に依存しません。

        パーティションインデックスの算出に必要とする情報はキャッシュされ、次にクラスタ障害・クラスタノード障害を検知するまで再びGridDBクラスタに問い合わせることはありません。

        Parameters:
        containerName - コンテナ名。nullは指定できない
        Returns:
        指定のコンテナ名に対応するパーティションインデックス
        Throws:
        GSException - コンテナ名として許可されない文字列が指定された場合
        GSException - この処理のタイムアウト、接続障害が発生した場合、このオブジェクトまたは対応するGridStoreのクローズ後に呼び出された場合
        java.lang.NullPointerException - 引数にnullが指定された場合

Interface Query<R>

  • Type Parameters:
    R - 期待される取得結果のRowSet要素の型
    All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable


    public interface Query<R>
    extends java.io.Closeable
    特定のContainerに対応付けられたクエリを保持し、結果取得方法の設定ならびに実行・結果取得を行う機能を持ちます。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      関連するリソースを適宜解放します。
      RowSet<R> fetch()
      このクエリを実行し、実行結果に対応するロウ集合を取得します。
      RowSet<R> fetch(boolean forUpdate)
      オプションを指定してこのクエリを実行し、実行結果に対応するロウ集合を取得します。
      RowSet<R> getRowSet()
      直近に実行した結果のRowSetを取得します。
      void setFetchOption(FetchOption option, java.lang.Object value)
      結果取得に関するオプションを設定します。
    • Method Detail

      • close

        void close()
                   throws GSException
        関連するリソースを適宜解放します。
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        GSException - 現バージョンでは送出されない
        See Also:
        Closeable.close()
      • fetch

        RowSet<R> fetch()
                        throws GSException
        このクエリを実行し、実行結果に対応するロウ集合を取得します。

        更新用ロックを要求せずにfetch(boolean)を呼び出した場合と同様です。

        Throws:
        GSException - 正しくないパラメータ・構文・命令を含むクエリを実行しようとした場合。たとえば、TQLでは、関数の引数に対応しない型のカラムを指定した場合。具体的な制約は、このクエリを作成する機能の各種定義を参照のこと
        GSException - TQLを実行した際、実行結果が期待する結果 RowSetの各要素の型と合致しない場合
        GSException - この処理または関連するトランザクションのタイムアウト、対応するコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
        java.lang.NullPointerException - このクエリを作成する際に与えられたパラメータの中に、許容されないnullが含まれていた場合。GridDB上で実行される TQL文の評価処理の結果として送出されることはない
        See Also:
        fetch(boolean)
      • fetch

        RowSet<R> fetch(boolean forUpdate)
                        throws GSException
        オプションを指定してこのクエリを実行し、実行結果に対応するロウ集合を取得します。

        forUpdatetrueが指定された場合、取得対象のロウすべてをロックします。ロックすると、対応するトランザクションが有効である間、他のトランザクションからの対象ロウに対する変更操作が阻止されます。対応するコンテナの自動コミットモードが無効の場合のみ、指定できます。

        新たなロウ集合を取得すると、このクエリについて前回実行した結果の RowSetはクローズされます。

        バージョン1.1またはそれ以前のバージョンでは、このオブジェクトのクローズ後も呼び出すことができました。また、直近に実行した結果のRowSet がクローズされることはありませんでした。

        一度に大量のロウを取得しようとした場合、GridDBノードが管理する通信バッファのサイズの上限に到達し、失敗することがあります。上限サイズについては、GridDBテクニカルリファレンスを参照してください。

        Throws:
        GSException - 対応するコレクションの自動コミットモード有効であるにもかかわらず、forUpdatetrueが指定された場合
        GSException - ロックできないクエリであるにもかかわらず、 forUpdatetrueが指定された場合。具体的なロックの可否は、このクエリを作成する機能の各種定義を参照のこと
        GSException - 正しくないパラメータ・構文・命令を含むクエリを実行しようとした場合。たとえば、TQLでは、関数の引数に対応しない型のカラムを指定した場合。具体的な制約は、このクエリを作成する機能の各種定義を参照のこと
        GSException - TQLの実行時、求めるRowSetの要素の型と取得結果の型が一致しない場合
        GSException - この処理または関連するトランザクションのタイムアウト、対応するコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
        java.lang.NullPointerException - このクエリを作成する際に与えられたパラメータの中に、許容されないnullが含まれていた場合
      • getRowSet

        RowSet<R> getRowSet()
                            throws GSException
        直近に実行した結果のRowSetを取得します。

        一度取得すると、以降新たにこのクエリを実行するまでnullが返却されるようになります。

        Returns:
        直近に実行した結果のRowSet。取得済みの場合、もしくは、一度もクエリを実行したことのない場合はnull
        Throws:
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
        Since:
        1.5
      • setFetchOption

        void setFetchOption(FetchOption option,
                          java.lang.Object value)
                            throws GSException
        結果取得に関するオプションを設定します。

        設定可能なオプション項目と値の定義については、FetchOptionを参照してください。

        バージョン1.1またはそれ以前のバージョンでは、このオブジェクトまたは対応する Containerのクローズ後も呼び出すことができました。

        Parameters:
        option - オプション項目
        value - オプションの値
        Throws:
        GSException - オプションの値がオプション項目と対応しない場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
        java.lang.NullPointerException - 1つ以上の引数にnullが指定された場合
        See Also:
        FetchOption

Class QueryAnalysisEntry

  • java.lang.Object
    • com.toshiba.mwcloud.gs.QueryAnalysisEntry


  • public class QueryAnalysisEntry
    extends java.lang.Object
    クエリプランならびにクエリ処理解析結果を構成する一連の情報の一つを示します。

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

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      このオブジェクトと他のオブジェクトが等しいかどうかを示します。
      int getDepth()
      他のエントリとの関係を表すための、深さを取得します。
      int getId()
      一連のエントリ列における、このエントリの位置を示すIDを取得します。
      java.lang.String getStatement()
      このエントリが示す情報に対応するTQL文の一部を取得します。
      java.lang.String getType()
      このエントリが示す情報の種別を取得します。
      java.lang.String getValue()
      このエントリが示す情報に対応付けられた値の文字列表現を取得します。
      java.lang.String getValueType()
      このエントリが示す情報に対応付けられた値の型を取得します。
      int hashCode()
      このオブジェクトのハッシュコード値を返します。
      void setDepth(int depth)
      他のエントリとの関係を表すための、深さを設定します。
      void setId(int id)
      一連のエントリ列における、このエントリの位置を示すIDを設定します。
      void setStatement(java.lang.String statement)
      このエントリが示す情報に対応するTQL文の一部を設定します。
      void setType(java.lang.String type)
      このエントリが示す情報の種別を設定します。
      void setValue(java.lang.String value)
      このエントリが示す情報に対応付けられた値の文字列表現を設定します。
      void setValueType(java.lang.String valueType)
      このエントリが示す情報に対応付けられた値の型を設定します。
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • QueryAnalysisEntry

        public QueryAnalysisEntry()
    • Method Detail

      • equals

        public boolean equals(java.lang.Object obj)
        このオブジェクトと他のオブジェクトが等しいかどうかを示します。

        getId()getDepth()などにより得られる各値がすべて等価である場合のみ、指定のオブジェクトと等価であるとみなされます。

        このメソッドは、Object.hashCode()にて定義されている汎用規約に準拠します。したがって、等価なオブジェクトは等価なハッシュコードを保持します。

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - 比較対象の参照オブジェクト
        Returns:
        このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse
        See Also:
        hashCode()
      • getDepth

        public int getDepth()
        他のエントリとの関係を表すための、深さを取得します。

        このエントリより小さな値のIDを順にたどり、このエントリの深さより1だけ浅いエントリが存在した場合、このエントリは、該当するエントリの内容をより詳しく説明するためのものであることを意味します。

      • getId

        public int getId()
        一連のエントリ列における、このエントリの位置を示すIDを取得します。

        TQLを実行した結果を受け取る場合、IDは1から順に割り当てられます。

      • getStatement

        public java.lang.String getStatement()
        このエントリが示す情報に対応するTQL文の一部を取得します。

        対応関係を持たない場合は空文字列を取得します。

      • getType

        public java.lang.String getType()
        このエントリが示す情報の種別を取得します。

        実行時間といった解析結果の種別、クエリプランの構成要素の種別などを表します。

      • getValue

        public java.lang.String getValue()
        このエントリが示す情報に対応付けられた値の文字列表現を取得します。

        値が対応づけられていない場合は空文字列を取得します。

        See Also:
        getValueType()
      • getValueType

        public java.lang.String getValueType()
        このエントリが示す情報に対応付けられた値の型を取得します。

        実行時間といった解析結果などに対応する値の型を取得します。型の名称は、TQLで定義された基本型のうち次のものです。

        • STRING
        • BOOL
        • BYTE
        • SHORT
        • INTEGER
        • LONG
        • FLOAT
        • DOUBLE

        値が対応づけられていない場合は空文字列を取得します。

      • hashCode

        public int hashCode()
        このオブジェクトのハッシュコード値を返します。

        このメソッドは、Object.hashCode()にて定義されている汎用規約に準拠します。したがって、等価なオブジェクトのハッシュコード値は等価です。

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        このオブジェクトのハッシュコード値
        See Also:
        equals(Object)
      • setDepth

        public void setDepth(int depth)
        他のエントリとの関係を表すための、深さを設定します。
        See Also:
        getDepth()
      • setId

        public void setId(int id)
        一連のエントリ列における、このエントリの位置を示すIDを設定します。
        See Also:
        getId()
      • setStatement

        public void setStatement(java.lang.String statement)
        このエントリが示す情報に対応するTQL文の一部を設定します。
        See Also:
        getStatement()
      • setType

        public void setType(java.lang.String type)
        このエントリが示す情報の種別を設定します。
        See Also:
        getType()
      • setValue

        public void setValue(java.lang.String value)
        このエントリが示す情報に対応付けられた値の文字列表現を設定します。
        See Also:
        getValue()
      • setValueType

        public void setValueType(java.lang.String valueType)
        このエントリが示す情報に対応付けられた値の型を設定します。
        See Also:
        getValueType()

Enum QueryOrder

  • java.lang.Object
    • java.lang.Enum<QueryOrder>
      • com.toshiba.mwcloud.gs.QueryOrder
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<QueryOrder>


    public enum QueryOrder
    extends java.lang.Enum<QueryOrder>
    クエリにおける要求ロウ順序を表します。

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      ASCENDING
      要求ロウ順序が昇順であることを表します。
      DESCENDING
      要求ロウ順序が降順であることを表します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static QueryOrder valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static QueryOrder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ASCENDING

        public static final QueryOrder ASCENDING
        要求ロウ順序が昇順であることを表します。
      • DESCENDING

        public static final QueryOrder DESCENDING
        要求ロウ順序が降順であることを表します。
    • Method Detail

      • valueOf

        public static QueryOrder valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static QueryOrder[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (QueryOrder c : QueryOrder.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Interface Row



  • public interface Row
    任意のスキーマについて汎用的にフィールド操作できるロウです。
    Since:
    1.5
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.sql.Blob getBlob(int column)
      指定のBLOB型フィールドの値を取得します。
      boolean getBool(int column)
      指定のBOOL型フィールドの値を取得します。
      boolean[] getBoolArray(int column)
      指定のBOOL型配列フィールドの値を取得します。
      byte getByte(int column)
      指定のBYTE型フィールドの値を取得します。
      byte[] getByteArray(int column)
      指定のBYTE型配列フィールドの値を取得します。
      double getDouble(int column)
      指定のDOUBLE型フィールドの値を取得します。
      double[] getDoubleArray(int column)
      指定のDOUBLE型配列フィールドの値を取得します。
      float getFloat(int column)
      指定のFLOAT型フィールドの値を取得します。
      float[] getFloatArray(int column)
      指定のFLOAT型配列フィールドの値を取得します。
      Geometry getGeometry(int column)
      指定のGEOMETRY型フィールドの値を取得します。
      int getInteger(int column)
      指定のINTEGER型フィールドの値を取得します。
      int[] getIntegerArray(int column)
      指定のINTEGER型配列フィールドの値を取得します。
      long getLong(int column)
      指定のLONG型フィールドの値を取得します。
      long[] getLongArray(int column)
      指定のLONG型配列フィールドの値を取得します。
      ContainerInfo getSchema()
      このロウに対応するスキーマを取得します。
      short getShort(int column)
      指定のSHORT型フィールドの値を取得します。
      short[] getShortArray(int column)
      指定のSHORT型配列フィールドの値を取得します。
      java.lang.String getString(int column)
      指定のSTRING型フィールドの値を取得します。
      java.lang.String[] getStringArray(int column)
      指定のSTRING型配列フィールドの値を取得します。
      java.util.Date getTimestamp(int column)
      指定のTIMESTAMP型フィールドの値を取得します。
      java.util.Date[] getTimestampArray(int column)
      指定のTIMESTAMP型配列フィールドの値を取得します。
      java.lang.Object getValue(int column)
      指定のフィールドの値を取得します。
      boolean isNull(int column)
      指定のフィールドにNULLが設定されているかどうかを返します。
      void setBlob(int column, java.sql.Blob fieldValue)
      指定のBLOB型フィールドに値を設定します。
      void setBool(int column, boolean fieldValue)
      指定のBOOL型フィールドに値を設定します。
      void setBoolArray(int column, boolean[] fieldValue)
      指定のBOOL型配列フィールドに値を設定します。
      void setByte(int column, byte fieldValue)
      指定のBYTE型フィールドに値を設定します。
      void setByteArray(int column, byte[] fieldValue)
      指定のBYTE型配列フィールドに値を設定します。
      void setDouble(int column, double fieldValue)
      指定のDOUBLE型フィールドに値を設定します。
      void setDoubleArray(int column, double[] fieldValue)
      指定のDOUBLE型配列フィールドに値を設定します。
      void setFloat(int column, float fieldValue)
      指定のFLOAT型フィールドに値を設定します。
      void setFloatArray(int column, float[] fieldValue)
      指定のFLOAT型配列フィールドに値を設定します。
      void setGeometry(int column, Geometry fieldValue)
      指定のGEOMETRY型フィールドに値を設定します。
      void setInteger(int column, int fieldValue)
      指定のINTEGER型フィールドに値を設定します。
      void setIntegerArray(int column, int[] fieldValue)
      指定のINTEGER型配列フィールドに値を設定します。
      void setLong(int column, long fieldValue)
      指定のLONG型フィールドに値を設定します。
      void setLongArray(int column, long[] fieldValue)
      指定のLONG型配列フィールドに値を設定します。
      void setNull(int column)
      指定のフィールドにNULLを設定します。
      void setShort(int column, short fieldValue)
      指定のSHORT型フィールドに値を設定します。
      void setShortArray(int column, short[] fieldValue)
      指定のSHORT型配列フィールドに値を設定します。
      void setString(int column, java.lang.String fieldValue)
      指定のSTRING型フィールドに値を設定します。
      void setStringArray(int column, java.lang.String[] fieldValue)
      指定のSTRING型配列フィールドに値を設定します。
      void setTimestamp(int column, java.util.Date fieldValue)
      指定のTIMESTAMP型フィールドに値を設定します。
      void setTimestampArray(int column, java.util.Date[] fieldValue)
      指定のTIMESTAMP型配列フィールドに値を設定します。
      void setValue(int column, java.lang.Object fieldValue)
      指定のフィールドに値を設定します。
    • Method Detail

      • getBlob

        java.sql.Blob getBlob(int column)
                              throws GSException
        指定のBLOB型フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getBool

        boolean getBool(int column)
                        throws GSException
        指定のBOOL型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getBoolArray

        boolean[] getBoolArray(int column)
                               throws GSException
        指定のBOOL型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getByte

        byte getByte(int column)
                     throws GSException
        指定のBYTE型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getByteArray

        byte[] getByteArray(int column)
                            throws GSException
        指定のBYTE型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getDouble

        double getDouble(int column)
                         throws GSException
        指定のDOUBLE型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getDoubleArray

        double[] getDoubleArray(int column)
                                throws GSException
        指定のDOUBLE型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getFloat

        float getFloat(int column)
                       throws GSException
        指定のFLOAT型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getFloatArray

        float[] getFloatArray(int column)
                              throws GSException
        指定のFLOAT型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getGeometry

        Geometry getGeometry(int column)
                             throws GSException
        指定のGEOMETRY型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getInteger

        int getInteger(int column)
                       throws GSException
        指定のINTEGER型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getIntegerArray

        int[] getIntegerArray(int column)
                              throws GSException
        指定のINTEGER型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getLong

        long getLong(int column)
                     throws GSException
        指定のLONG型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getLongArray

        long[] getLongArray(int column)
                            throws GSException
        指定のLONG型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getSchema

        ContainerInfo getSchema()
                                throws GSException
        このロウに対応するスキーマを取得します。

        ロウキーの有無を含むカラムレイアウトにする情報のみが設定された ContainerInfoが求まります。コンテナ名、コンテナ種別、索引設定、時系列構成オプションなどその他のコンテナ情報は含まれません。

        Returns:
        スキーマに関するコンテナ情報のみを持つContainerInfo
        Throws:
        GSException - 現バージョンでは送出されない
      • getShort

        short getShort(int column)
                       throws GSException
        指定のSHORT型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合は空の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getShortArray

        short[] getShortArray(int column)
                              throws GSException
        指定のSHORT型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getString

        java.lang.String getString(int column)
                                   throws GSException
        指定のSTRING型フィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getStringArray

        java.lang.String[] getStringArray(int column)
                                          throws GSException
        指定のSTRING型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getTimestamp

        java.util.Date getTimestamp(int column)
                                    throws GSException
        指定のTIMESTAMP型フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更した場合に、このオブジェクトの内容が変化するかどうかは未定義です。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getTimestampArray

        java.util.Date[] getTimestampArray(int column)
                                           throws GSException
        指定のTIMESTAMP型配列フィールドの値を取得します。

        返却されたオブジェクトの内容を呼び出し後に変更した場合に、このオブジェクトの内容が変化するかどうかは未定義です。一方、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • getValue

        java.lang.Object getValue(int column)
                                  throws GSException
        指定のフィールドの値を取得します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        対象フィールドの値。NULLが設定されている場合はnull
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
      • isNull

        boolean isNull(int column)
                       throws GSException
        指定のフィールドにNULLが設定されているかどうかを返します。

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

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Returns:
        指定のフィールドにNULLが設定されているかどうか
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        Since:
        3.5
      • setBlob

        void setBlob(int column,
                   java.sql.Blob fieldValue)
                     throws GSException
        指定のBLOB型フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setBool

        void setBool(int column,
                   boolean fieldValue)
                     throws GSException
        指定のBOOL型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setBoolArray

        void setBoolArray(int column,
                        boolean[] fieldValue)
                          throws GSException
        指定のBOOL型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setByte

        void setByte(int column,
                   byte fieldValue)
                     throws GSException
        指定のBYTE型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setByteArray

        void setByteArray(int column,
                        byte[] fieldValue)
                          throws GSException
        指定のBYTE型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setDouble

        void setDouble(int column,
                     double fieldValue)
                       throws GSException
        指定のDOUBLE型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setDoubleArray

        void setDoubleArray(int column,
                          double[] fieldValue)
                            throws GSException
        指定のDOUBLE型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setFloat

        void setFloat(int column,
                    float fieldValue)
                      throws GSException
        指定のFLOAT型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setFloatArray

        void setFloatArray(int column,
                         float[] fieldValue)
                           throws GSException
        指定のFLOAT型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setGeometry

        void setGeometry(int column,
                       Geometry fieldValue)
                         throws GSException
        指定のGEOMETRY型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setInteger

        void setInteger(int column,
                      int fieldValue)
                        throws GSException
        指定のINTEGER型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setIntegerArray

        void setIntegerArray(int column,
                           int[] fieldValue)
                             throws GSException
        指定のINTEGER型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setLong

        void setLong(int column,
                   long fieldValue)
                     throws GSException
        指定のLONG型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setLongArray

        void setLongArray(int column,
                        long[] fieldValue)
                          throws GSException
        指定のLONG型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setNull

        void setNull(int column)
                     throws GSException
        指定のフィールドにNULLを設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムが指定された場合
        Since:
        3.5
      • setShort

        void setShort(int column,
                    short fieldValue)
                      throws GSException
        指定のSHORT型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setShortArray

        void setShortArray(int column,
                         short[] fieldValue)
                           throws GSException
        指定のSHORT型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setString

        void setString(int column,
                     java.lang.String fieldValue)
                       throws GSException
        指定のSTRING型フィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setStringArray

        void setStringArray(int column,
                          java.lang.String[] fieldValue)
                            throws GSException
        指定のSTRING型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - フィールド値の配列要素にnullが含まれる場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setTimestamp

        void setTimestamp(int column,
                        java.util.Date fieldValue)
                          throws GSException
        指定のTIMESTAMP型フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更した場合に、このオブジェクトの内容が変化するかどうかは未定義です。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setTimestampArray

        void setTimestampArray(int column,
                             java.util.Date[] fieldValue)
                               throws GSException
        指定のTIMESTAMP型配列フィールドに値を設定します。

        指定したオブジェクトの内容を呼び出し後に変更した場合に、このオブジェクトの内容が変化するかどうかは未定義です。

        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - フィールド値の配列要素にnullが含まれる場合
        GSException - 指定のカラム番号の型と一致しない場合
      • setValue

        void setValue(int column,
                    java.lang.Object fieldValue)
                      throws GSException
        指定のフィールドに値を設定します。
        Parameters:
        column - 対象フィールドのカラム番号。0以上かつカラム数未満の値
        fieldValue - 対象フィールドの値
        Throws:
        GSException - 範囲外のカラム番号が指定された場合
        GSException - NOT NULL制約の設定されたカラムに対して、フィールド値としてnullが指定された場合
        GSException - 配列型のフィールド値の配列要素にnullが含まれる場合
        GSException - フィールドの値がカラムの型と一致しない場合

Annotation Type RowField



  • @Retention(value=RUNTIME)
    @Target(value={FIELD,METHOD})
    public @interface RowField
    Containerの処理におけるマッピング対象のロウフィールドについて、オプションを設定します。
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      int columnNumber
      カラム番号を設定します。
      java.lang.String name
      指定のカラム名を使用します。
    • Element Detail

      • columnNumber

        public abstract int columnNumber
        カラム番号を設定します。

        カラム順序を明示的に指定する場合、0以上かつカラム数未満の値を指定します。同一コンテナ上で重複するカラム番号を指定することはできません。また、ロウキーは常に先頭カラムになるように設定しなければなりません。デフォルト値の-1を指定した場合、対応するカラムの番号は自動的に決定されます。

        Default:
        -1
      • name

        public abstract java.lang.String name
        指定のカラム名を使用します。

        空の文字を指定した場合、対応するフィールド名またはメソッド名に基づきカラム名を決定します。

        Default:
        ""

Annotation Type RowKey



  • @Retention(value=RUNTIME)
    @Target(value={FIELD,METHOD})
    public @interface RowKey
    Containerのキーと対応することを示します。

Class RowKeyPredicate<K>

  • java.lang.Object
    • com.toshiba.mwcloud.gs.RowKeyPredicate<K>
  • Type Parameters:
    K - 合致条件の評価対象とするロウキーの型


    public class RowKeyPredicate<K>
    extends java.lang.Object
    ロウキーの合致条件を表します。

    GridStore.multiGet(java.util.Map)における取得条件を構成するために使用できます。

    条件の種別として、範囲条件と個別条件の2つの種別があります。両方の種別の条件を共に指定することはできません。条件の内容を何も指定しない場合、対象とするすべてのロウキーに合致することを表します。

    Since:
    1.5
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void add(K key)
      個別条件の要素の一つとするロウキーの値を追加します。
      static <K> RowKeyPredicate<K> create(java.lang.Class<K> keyType)
      指定のClassに対応するGSTypeをロウキーの型とする合致条件を作成します。
      static RowKeyPredicate<java.lang.Object> create(GSType keyType)
      指定のGSTypeをロウキーの型とする合致条件を作成します。
      java.util.Collection<K> getDistinctKeys()
      個別条件を構成するロウキーの値の集合を取得します。
      K getFinish()
      範囲条件の終了位置とするロウキーの値を取得します。
      GSType getKeyType()
      合致条件の評価対象とするロウキーの型を取得します。
      K getStart()
      範囲条件の開始位置とするロウキーの値を取得します。
      void setFinish(K finishKey)
      範囲条件の終了位置とするロウキーの値を設定します。
      void setStart(K startKey)
      範囲条件の開始位置とするロウキーの値を設定します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • add

        public void add(K key)
                 throws GSException
        個別条件の要素の一つとするロウキーの値を追加します。

        追加された値と同一の値のロウキーは合致するものとみなされるようになります。

        Parameters:
        key - 個別条件の要素の一つとするロウキーの値。nullは指定できない
        Throws:
        GSException - 範囲条件がすでに設定されていた場合
        java.lang.ClassCastException - 指定のロウキーの値の型がnull ではなく、ロウキーに対応するクラスのインスタンスではない場合
      • create

        public static <K> RowKeyPredicate<K> create(java.lang.Class<K> keyType)
                                         throws GSException
        指定のClassに対応するGSTypeをロウキーの型とする合致条件を作成します。

        判定対象とするコンテナは、ロウキーを持ち、かつ、ロウキーの型が対応する GSTypeと同一の型でなければなりません。

        設定可能なロウキーの型は、Containerのいずれかのサブインタフェースにて許容されている型のみです。 ClassGSTypeとの対応関係については、 Containerの定義を参照してください。

        Parameters:
        keyType - 合致条件の判定対象とするロウキーの型に対応する、Class
        Returns:
        新規に作成されたRowKeyPredicate
        Throws:
        GSException - 指定された型がロウキーとして常にサポート外となる場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        See Also:
        Container
      • create

        public static RowKeyPredicate<java.lang.Object> create(GSType keyType)
                                                        throws GSException
        指定のGSTypeをロウキーの型とする合致条件を作成します。

        合致条件の評価対象とするコンテナは、ロウキーを持ち、かつ、ロウキーの型が指定のGSTypeと同一の型でなければなりません。

        create(Class)とは異なり、アプリケーションのコンパイル時点でロウキーの型が確定しない場合の使用に適します。ただし、条件内容を設定する際のロウキーの型チェックの基準は同一です。

        設定可能なロウキーの型は、Containerのいずれかのサブインタフェースにて許容されている型のみです。

        Parameters:
        keyType - 合致条件の評価対象とするロウキーの型
        Returns:
        新規に作成されたRowKeyPredicate
        Throws:
        GSException - 指定された型がロウキーとして常にサポート外となる場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        See Also:
        Container
      • getDistinctKeys

        public java.util.Collection<K> getDistinctKeys()
        個別条件を構成するロウキーの値の集合を取得します。

        返却された値に対して変更操作を行った場合に、 UnsupportedOperationExceptionなどの実行時例外が発生するかどうかは未定義です。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化するかどうかは未定義です。

        Returns:
        個別条件を構成するロウキーの値を要素とする Collection
      • getFinish

        public K getFinish()
        範囲条件の終了位置とするロウキーの値を取得します。
        Returns:
        終了位置とするロウキーの値。設定されていない場合はnull
      • getKeyType

        public GSType getKeyType()
        合致条件の評価対象とするロウキーの型を取得します。
        Returns:
        合致条件の評価対象とするロウキーの型
      • getStart

        public K getStart()
        範囲条件の開始位置とするロウキーの値を取得します。
        Returns:
        開始位置とするロウキーの値。設定されていない場合はnull
      • setFinish

        public void setFinish(K finishKey)
                       throws GSException
        範囲条件の終了位置とするロウキーの値を設定します。

        設定された値より大きな値のロウキーは合致しないものとみなされるようになります。

        STRING型のように大小関係の定義されていない型の場合、条件として設定はできるものの、実際の判定に用いることはできません。

        Parameters:
        finishKey - 終了位置とするロウキーの値。nullの場合、設定が解除される
        Throws:
        GSException - 個別条件がすでに設定されていた場合
        java.lang.ClassCastException - 指定のロウキーの値の型がnull ではなく、ロウキーに対応するクラスのインスタンスではない場合
      • setStart

        public void setStart(K startKey)
                      throws GSException
        範囲条件の開始位置とするロウキーの値を設定します。

        設定された値より小さな値のロウキーは合致しないものとみなされるようになります。

        STRING型のように大小関係の定義されていない型の場合、条件として設定はできるものの、実際の判定に用いることはできません。

        Parameters:
        startKey - 開始位置とするロウキーの値。nullの場合、設定が解除される
        Throws:
        GSException - 個別条件がすでに設定されていた場合
        java.lang.ClassCastException - 指定のロウキーの値の型がnull ではなく、ロウキーに対応するクラスのインスタンスではない場合

Interface RowSet<R>

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable


    public interface RowSet<R>
    extends java.io.Closeable
    クエリ実行より求めたロウの集合を管理します。

    ロウ単位・ロウフィールド単位での操作機能を持ち、対象とするロウを指し示すための、ResultSetと同様のカーソル状態を保持します。初期状態のカーソルは、ロウ集合の先頭より手前に位置しています。

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      関連するリソースを適宜解放します。
      boolean hasNext()
      現在のカーソル位置を基準として、ロウ集合内に後続のロウが存在するかどうかを取得します。
      R next()
      ロウ集合内の後続のロウにカーソル移動し、移動後の位置にあるロウオブジェクトを取得します。
      void remove()
      現在のカーソル位置のロウを削除します。
      int size()
      サイズ、すなわちロウ集合作成時点におけるロウの数を取得します。
      void update(R rowObj)
      現在のカーソル位置のロウについて、指定のロウオブジェクトを使用してロウキー以外の値を更新します。
    • Method Detail

      • close

        void close()
                   throws GSException
        関連するリソースを適宜解放します。
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        GSException - 現バージョンでは送出されない
        See Also:
        Closeable.close()
      • hasNext

        boolean hasNext()
                        throws GSException
        現在のカーソル位置を基準として、ロウ集合内に後続のロウが存在するかどうかを取得します。
        Throws:
        GSException - 現バージョンでは送出されない
      • next

        R next()
               throws GSException
        ロウ集合内の後続のロウにカーソル移動し、移動後の位置にあるロウオブジェクトを取得します。

        バージョン1.1またはそれ以前のバージョンでは、このオブジェクトまたは対応する Containerのクローズ後も呼び出すことができました。

        Throws:
        GSException - 対象位置のロウが存在しない場合
        GSException - 接続障害によりロウオブジェクトの生成に失敗した場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
      • remove

        void remove()
                    throws GSException
        現在のカーソル位置のロウを削除します。

        ロックを有効にして取得したRowSetに対してのみ使用できます。また、Container.remove(Object)と同様、コンテナの種別ならびに設定によっては、さらに制限が設けられています。

        バージョン1.1またはそれ以前のバージョンでは、このオブジェクトのクローズ後も呼び出すことができました。

        Throws:
        GSException - 対象位置のロウが存在しない場合
        GSException - ロックを有効にせずに取得したRowSetに対して呼び出された場合
        GSException - 特定コンテナ固有の制限に反する操作を行った場合
        GSException - この処理または関連するトランザクションのタイムアウト、対応するコンテナの削除もしくはスキーマ変更、接続障害が発生した場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
      • size

        int size()
        サイズ、すなわちロウ集合作成時点におけるロウの数を取得します。
      • update

        void update(R rowObj)
                    throws GSException
        現在のカーソル位置のロウについて、指定のロウオブジェクトを使用してロウキー以外の値を更新します。

        nullは指定できません。指定のロウオブジェクトに含まれるロウキーは無視されます。

        ロックを有効にして取得したRowSetに対してのみ使用できます。また、Container.put(Object, Object)と同様、コンテナの種別ならびに設定によっては、さらに制限が設けられています。

        バージョン1.1またはそれ以前のバージョンでは、このオブジェクトのクローズ後も呼び出すことができました。

        Throws:
        GSException - 対象位置のロウが存在しない場合
        GSException - ロックを有効にせずに取得したRowSetに対して呼び出された場合
        GSException - 特定コンテナ固有の制限に反する操作を行った場合
        GSException - この処理または関連するトランザクションのタイムアウト、対応するンテナの削除もしくはスキーマ変更、接続障害が発生した場合
        GSException - このオブジェクトまたは対応するContainerのクローズ後に呼び出された場合
        java.lang.ClassCastException - 指定のロウオブジェクトがマッピング処理で使用されるロウオブジェクトの型と対応しない場合
        java.lang.NullPointerException - 引数にnullが指定された場合。また、ロウフィールドに対応するロウオブジェクト内のオブジェクトが1つ以上存在しない場合

Enum TimeOperator

  • java.lang.Object
    • java.lang.Enum<TimeOperator>
      • com.toshiba.mwcloud.gs.TimeOperator
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TimeOperator>


    public enum TimeOperator
    extends java.lang.Enum<TimeOperator>
    TimeSeriesのキー時刻に基づく、ロウの特定方法を表します。

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      NEXT
      指定時刻同一またはまたはより後の時刻のロウのうち、最も古いものを求めます。
      NEXT_ONLY
      指定時刻より後の時刻のロウのうち、最も古いものを求めます。
      PREVIOUS
      指定時刻と同一またはより前の時刻のロウのうち、最も新しいものを求めます。
      PREVIOUS_ONLY
      指定より前の時刻のロウのうち、最も新しいものを求めます。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static TimeOperator valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TimeOperator[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NEXT

        public static final TimeOperator NEXT
        指定時刻同一またはまたはより後の時刻のロウのうち、最も古いものを求めます。
      • NEXT_ONLY

        public static final TimeOperator NEXT_ONLY
        指定時刻より後の時刻のロウのうち、最も古いものを求めます。
      • PREVIOUS

        public static final TimeOperator PREVIOUS
        指定時刻と同一またはより前の時刻のロウのうち、最も新しいものを求めます。
      • PREVIOUS_ONLY

        public static final TimeOperator PREVIOUS_ONLY
        指定より前の時刻のロウのうち、最も新しいものを求めます。
    • Method Detail

      • valueOf

        public static TimeOperator valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static TimeOperator[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TimeOperator c : TimeOperator.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Interface TimeSeries<R>

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, Container<java.util.Date,R>


    public interface TimeSeries<R>
    extends Container<java.util.Date,R>
    時刻をロウキーとする、時系列処理に特化したコンテナです。

    一般的に、範囲取得や集計演算といった処理は、Collectionよりも効率的な実装が選択されます。

    ロウ操作については、Collectionと異なり一部制限が設けられています。 TimeSeriesPropertiesに基づき圧縮オプションが設定されている場合、次のロウ操作を行えません。

    • 指定ロウの更新
    • 指定ロウの削除
    • 指定時刻より新しい時刻のロウが存在する場合の、ロウの新規作成

    Container.query(String)GridStore.multiGet(java.util.Map)などより複数のロウの内容を一度に取得する場合、特に指定がなければ、返却されるロウの順序はロウキーの時刻を基準としてQueryOrder.ASCENDING 相当の順序に整列されます。

    ロック粒度は、1つ以上のロウ集合をひとまとまりとする内部格納単位となります。したがって、特定ロウについてロックする際、そのロウが属する内部格納単位上の他のロウも同時にロックしようとします。

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      AggregationResult aggregate(java.util.Date start, java.util.Date end, java.lang.String column, Aggregation aggregation)
      開始・終了時刻指定を指定して、ロウ集合またはその特定のカラムに対し集計演算を行います。
      boolean append(R row)
      GridDB上の現在時刻をロウキーとして、ロウを新規作成または更新します。
      R get(java.util.Date key)
      指定のオプションに従い、ロウキーに対応するロウの内容を取得します。
      R get(java.util.Date base, TimeOperator timeOp)
      指定の時刻を基準として、関係する1つのロウを取得します。
      R interpolate(java.util.Date base, java.lang.String column)
      指定時刻に相当するロウオブジェクトについて、線形補間などを行い生成します。
      boolean put(java.util.Date key, R row)
      必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。
      Query<R> query(java.util.Date start, java.util.Date end)
      開始時刻・終了時刻を指定して、特定範囲のロウ集合を求めるクエリを作成します。
      Query<R> query(java.util.Date start, java.util.Date end, QueryOrder order)
      開始時刻・終了時刻・順序を指定して、特定範囲のロウ集合を求めるクエリを作成します。
      Query<R> query(java.util.Date start, java.util.Date end, java.util.Set<java.lang.String> columnSet, InterpolationMode mode, int interval, TimeUnit intervalUnit)
      特定範囲のロウ集合をサンプリングするクエリを作成します。
      boolean remove(java.util.Date key)
      指定のロウキーに対応するロウを削除します。
    • Method Detail

      • aggregate

        AggregationResult aggregate(java.util.Date start,
                                  java.util.Date end,
                                  java.lang.String column,
                                  Aggregation aggregation)
                                    throws GSException
        開始・終了時刻指定を指定して、ロウ集合またはその特定のカラムに対し集計演算を行います。

        columnは、aggregation次第で無視されることがあります。演算対象には、開始・終了時刻と合致する境界上のロウも含まれます。終了時刻より新しい開始時刻を指定した場合、すべてのロウが対象外となります。

        Parameters:
        start - 開始時刻
        end - 終了時刻
        column - 集計対象のカラム名。合計演算のように、特定のカラムを対象としない場合はnull
        aggregation - 集計方法
        Returns:
        集計結果が設定された場合、対応するAggregationResult。設定されなかった場合はnull。詳細はAggregationの定義を参照のこと
        Throws:
        GSException - 指定の演算方法で許可されていない型のカラムを指定した場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合
        java.lang.NullPointerException - startendaggregationnullが指定された場合
        See Also:
        Aggregation
      • append

        boolean append(R row)
                       throws GSException
        GridDB上の現在時刻をロウキーとして、ロウを新規作成または更新します。

        GridDB上の現在時刻に相当するTIMESTAMP値をロウキーとする点を除き、 put(Date, Object)と同様に振る舞います。指定のロウオブジェクト内のロウキーは無視されます。

        圧縮オプションが設定された状態の時系列に対しては、 GridDB上の現在時刻より新しい時刻のロウが存在しない場合のみ使用できます。最も新しい時刻を持つ既存ロウの時刻が現在時刻と一致する場合、何も変更は行わず既存ロウの内容を保持します。

        手動コミットモードの場合、対象のロウがロックされます。また、内部格納単位が同一の他のロウもロックされます。

        Parameters:
        row - 新規作成または更新するロウの内容と対応するロウオブジェクト
        Returns:
        GridDB上の現在時刻と一致するロウが存在したかどうか
        Throws:
        GSException - この時系列について圧縮オプションが設定されており、現在時刻より新しい時刻のロウが存在した場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がロウオブジェクトに含まれていた場合
        java.lang.ClassCastException - 指定のキーもしくはロウオブジェクトと、マッピング処理で使用される型との間で対応しないものがある場合
        java.lang.NullPointerException - rownullが指定された場合。また、ロウフィールドに対応するロウオブジェクト内のオブジェクトの中に、設定されていないものが存在した場合
        See Also:
        put(Date, Object), TimeSeriesProperties.getCompressionMethod()
      • get

        R get(java.util.Date key)
              throws GSException
        指定のオプションに従い、ロウキーに対応するロウの内容を取得します。

        Container.get(Object)と同様です。ただし、ロウキーの型が固定であるため、ClassCastExceptionが送出されることはありません。

        Specified by:
        get in interface Container<java.util.Date,R>
        Returns:
        対応するロウが存在したかどうか
        Throws:
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーとして設定されていた場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        See Also:
        Container.get(Object)
      • get

        R get(java.util.Date base,
            TimeOperator timeOp)
              throws GSException
        指定の時刻を基準として、関係する1つのロウを取得します。
        Parameters:
        base - 基準となる時刻
        timeOp - 取得方法
        Returns:
        条件に一致するロウ。存在しない場合はnull
        Throws:
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値が基準時刻として指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • interpolate

        R interpolate(java.util.Date base,
                    java.lang.String column)
                      throws GSException
        指定時刻に相当するロウオブジェクトについて、線形補間などを行い生成します。

        一致する時系列ロウの指定のカラムの値、もしくは、前後時刻のロウの指定カラムの値を線形補間して得られた値を基にロウオブジェクトを生成します。前後時刻のロウの少なくともいずれか、もしくは、一致するロウが存在しない場合は生成されません。

        補間対象として指定できるカラムの型は、数値型のみです。指定のカラムならびにロウキー以外のフィールドには、指定時刻と同一またはより前の時刻のロウのうち、最も新しい時刻を持つロウのフィールドの値が設定されます。

        Parameters:
        base - 基準となる時刻
        column - 線形補間対象のカラム
        Throws:
        GSException - 対応する名前のカラムが存在しない場合。また、サポートされていない型のカラムが指定された場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値が基準時刻として指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • put

        boolean put(java.util.Date key,
                  R row)
                    throws GSException
        必要に応じ別途ロウキーを指定して、ロウを新規作成または更新します。

        keyにより別途ロウキーを指定した場合はその値を、指定しない場合は指定のロウオブジェクト内のロウキーを基にロウを新規作成します。

        圧縮オプションが設定された状態の時系列に対しては、最も新しい時刻を持つ既存ロウより新しい時刻のロウのみを新規作成できます。最も新しい時刻を持つ既存ロウの時刻が指定の時刻と一致する場合、何も変更は行わず既存ロウの内容を保持します。

        手動コミットモードの場合、対象のロウがロックされます。また、内部格納単位が同一の他のロウもロックされます。

        Specified by:
        put in interface Container<java.util.Date,R>
        Parameters:
        key - 処理対象のロウキー
        row - 新規作成または更新するロウの内容と対応するロウオブジェクト
        Returns:
        指定のロウキーと一致するロウが存在したかどうか
        Throws:
        GSException - この時系列について圧縮オプションが設定されており、指定時刻より新しい時刻のロウが存在した場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーまたはロウオブジェクトに含まれていた場合
        java.lang.ClassCastException - 指定のキーもしくはロウオブジェクトと、マッピング処理で使用される型との間で対応しないものがある場合
        java.lang.NullPointerException - rownullが指定された場合。また、ロウフィールドに対応するロウオブジェクト内のオブジェクトの中に、設定されていないものが存在した場合
        See Also:
        Container.put(Object, Object), TimeSeriesProperties.getCompressionMethod()
      • query

        Query<R> query(java.util.Date start,
                     java.util.Date end)
                       throws GSException
        開始時刻・終了時刻を指定して、特定範囲のロウ集合を求めるクエリを作成します。

        取得対象には、開始・終了時刻と合致する境界上のロウも含まれます。終了時刻より新しい開始時刻を指定した場合、すべてのロウが対象外となります。要求するロウ集合は昇順、すなわち古い時刻から新しい時刻の順となります。

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

        Parameters:
        start - 開始時刻またはnullnullの場合、この時系列上の最も古いロウの時刻が開始時刻として指定されたものとみなす
        end - 終了時刻またはnullnullの場合、この時系列上の最も新しいロウの時刻が終了時刻として指定されたものとみなす
        Throws:
        GSException - 現バージョンでは送出されない
      • query

        Query<R> query(java.util.Date start,
                     java.util.Date end,
                     QueryOrder order)
                       throws GSException
        開始時刻・終了時刻・順序を指定して、特定範囲のロウ集合を求めるクエリを作成します。

        取得対象には、開始・終了時刻と合致する境界上のロウも含まれます。終了時刻より新しい開始時刻を指定した場合、すべてのロウが対象外となります。

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

        Parameters:
        start - 開始時刻またはnullnullの場合、この時系列上の最も古いロウの時刻が開始時刻として指定されたものとみなす
        end - 終了時刻またはnullnullの場合、この時系列上の最も新しいロウの時刻が終了時刻として指定されたものとみなす
        order - 取得するロウ集合の時刻順序。 QueryOrder.ASCENDINGの場合は古い時刻から新しい時刻の順、 QueryOrder.DESCENDINGの場合は新しい時刻から古い時刻の順となる
        Throws:
        GSException - 現バージョンでは送出されない
      • query

        Query<R> query(java.util.Date start,
                     java.util.Date end,
                     java.util.Set<java.lang.String> columnSet,
                     InterpolationMode mode,
                     int interval,
                     TimeUnit intervalUnit)
                       throws GSException
        特定範囲のロウ集合をサンプリングするクエリを作成します。

        サンプリング対象の時刻は、開始時刻に対し非負整数倍のサンプリング間隔を加えた時刻のうち、終了時刻と同じかそれ以前のもののみです。終了時刻より新しい開始時刻を指定した場合、すべてのロウが対象外となります。

        作成したクエリを実行すると、各サンプリング位置の時刻と一致するロウが存在する場合は該当ロウの値を、存在しない場合はcolumnSetmode引数の指定に従い補間された値を使用しロウ集合を生成します。個別の補間方法については、InterpolationModeの定義を参照してください。

        補間のために参照する必要のあるロウが存在しない場合、該当するサンプリング時刻のロウは生成されず、該当箇所の数だけ結果件数が減少します。サンプリング間隔をより短く設定すると、補間方法次第では異なるサンプリング時刻であっても同一のロウの内容が使用される可能性が高まります。

        Query.fetch(boolean)を通じてロウ集合を求める際、更新用ロックのオプションを有効にすることはできません。

        Parameters:
        start - 開始時刻
        end - 終了時刻
        columnSet - modeに基づき特定の補間処理を適用するカラムの名前の集合。空集合の場合は適用対象のカラムを何も指定しないことを示す。 nullの場合は空集合を指定した場合と同様
        mode - 補間方法
        interval - サンプリング間隔。0および負の値は指定できない
        intervalUnit - サンプリング間隔の時間単位。 TimeUnit.YEARTimeUnit.MONTHは指定できない
        Throws:
        GSException - 現バージョンでは送出されない
      • remove

        boolean remove(java.util.Date key)
                       throws GSException
        指定のロウキーに対応するロウを削除します。

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

        圧縮オプションが設定された状態の時系列に対しては使用できません。

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

        Specified by:
        remove in interface Container<java.util.Date,R>
        Returns:
        対応するロウが存在したかどうか
        Throws:
        GSException - ロウキーに対応するカラムが存在しない場合
        GSException - この時系列について圧縮オプションが設定されていた場合
        GSException - この処理またはトランザクションのタイムアウト、このコンテナの削除もしくはスキーマ変更、接続障害が発生した場合、クローズ後に呼び出された場合、またはサポート範囲外の値がキーとして指定された場合
        java.lang.ClassCastException - 指定のロウキーがマッピング処理で使用されるロウキーの型と対応しない場合
        java.lang.NullPointerException - 引数にnullが指定された場合
        See Also:
        Container.remove(Object), TimeSeriesProperties.getCompressionMethod()

Class TimeSeriesProperties

  • java.lang.Object
    • com.toshiba.mwcloud.gs.TimeSeriesProperties
  • All Implemented Interfaces:
    java.lang.Cloneable


    public class TimeSeriesProperties
    extends java.lang.Object
    implements java.lang.Cloneable
    時系列を新規作成または変更する際に使用される、オプションの構成情報を表します。

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

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      TimeSeriesProperties clone()
      このオブジェクトと同一設定のTimeSeriesPropertiesを作成します。
      CompressionMethod getCompressionMethod()
      時系列圧縮方式の種別を取得します。
      java.lang.Double getCompressionRate(java.lang.String column)
      指定のカラムについて、相対誤差あり間引き圧縮における、値がとりうる範囲を基準とした誤差境界値の比率を取得します。
      java.lang.Double getCompressionSpan(java.lang.String column)
      指定のカラムについての、相対誤差あり間引き圧縮で用いられる、値がとりうる範囲の最大値と最小値の差を取得します。
      java.lang.Double getCompressionWidth(java.lang.String column)
      指定のカラムについての、絶対誤差あり間引き圧縮における誤差境界の幅を取得します。
      int getCompressionWindowSize()
      間引き圧縮において連続して間引きされるロウの最大期間を取得します。
      TimeUnit getCompressionWindowSizeUnit()
      間引き圧縮において連続して間引きされるロウの最大期間の単位を取得します。
      int getExpirationDivisionCount()
      期限に到達したロウデータの解放単位と対応する、有効期間に対しての分割数を取得します。
      int getRowExpirationTime()
      ロウの有効期限の基準となる経過期間を取得します。
      TimeUnit getRowExpirationTimeUnit()
      ロウの有効期限の基準とする経過期間の単位を取得します。
      java.util.Set<java.lang.String> getSpecifiedColumns()
      追加設定のあるカラムの名前をすべて取得します。
      java.lang.Boolean isCompressionRelative(java.lang.String column)
      指定のカラムについて、誤差あり間引き圧縮の誤差判定基準値が相対値かどうかを返します。
      void setAbsoluteHiCompression(java.lang.String column, double width)
      指定のカラムについて、絶対誤差あり間引き圧縮のパラメータを設定します。
      void setCompressionMethod(CompressionMethod compressionMethod)
      時系列圧縮方式の種別を設定します。
      void setCompressionWindowSize(int compressionWindowSize, TimeUnit compressionWindowSizeUnit)
      間引き圧縮において、連続して間引きされるロウの最大期間を設定します。
      void setExpirationDivisionCount(int count)
      有効期間に対する分割数により、期限に到達したロウデータの解放単位を設定します。
      void setRelativeHiCompression(java.lang.String column, double rate, double span)
      指定のカラムについて、相対誤差あり間引き圧縮のパラメータを設定します。
      void setRowExpiration(int elapsedTime, TimeUnit timeUnit)
      ロウの有効期限の基準となる経過期間を設定します。
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TimeSeriesProperties

        public TimeSeriesProperties()
        標準設定のTimeSeriesPropertiesを作成します。
    • Method Detail

      • getCompressionMethod

        public CompressionMethod getCompressionMethod()
        時系列圧縮方式の種別を取得します。
        Returns:
        圧縮方式の種別。nullは返却されない
      • getCompressionRate

        public java.lang.Double getCompressionRate(java.lang.String column)
        指定のカラムについて、相対誤差あり間引き圧縮における、値がとりうる範囲を基準とした誤差境界値の比率を取得します。

        値がとりうる範囲は、getCompressionWidth(String)により取得できます。

        Parameters:
        column - カラム名
        Returns:
        指定のカラム名に対応する設定がある場合はその設定値、ない場合はnull
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • getCompressionSpan

        public java.lang.Double getCompressionSpan(java.lang.String column)
        指定のカラムについての、相対誤差あり間引き圧縮で用いられる、値がとりうる範囲の最大値と最小値の差を取得します。
        Parameters:
        column - カラム名
        Returns:
        指定のカラム名に対応する設定がある場合はその設定値、ない場合はnull
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • getCompressionWidth

        public java.lang.Double getCompressionWidth(java.lang.String column)
        指定のカラムについての、絶対誤差あり間引き圧縮における誤差境界の幅を取得します。

        誤差境界の幅とは、間引き判定対象の値と間引きした場合に線形補間される値との差として、許容される最大の値です。

        Parameters:
        column - カラム名
        Returns:
        指定のカラム名に対応する設定がある場合はその設定値、ない場合はnull
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • getCompressionWindowSize

        public int getCompressionWindowSize()
        間引き圧縮において連続して間引きされるロウの最大期間を取得します。
        Returns:
        最大連続間引き期間。無設定の場合は-1
      • getCompressionWindowSizeUnit

        public TimeUnit getCompressionWindowSizeUnit()
        間引き圧縮において連続して間引きされるロウの最大期間の単位を取得します。
        Returns:
        最大連続間引き期間の単位。無設定の場合はnull
      • getExpirationDivisionCount

        public int getExpirationDivisionCount()
        期限に到達したロウデータの解放単位と対応する、有効期間に対しての分割数を取得します。
        Returns:
        有効期間に対する分割数。無設定の場合は-1
        Since:
        2.0
        See Also:
        setExpirationDivisionCount(int)
      • getRowExpirationTime

        public int getRowExpirationTime()
        ロウの有効期限の基準となる経過期間を取得します。
        Returns:
        有効期限の基準となる経過期間。無設定の場合は-1
      • getRowExpirationTimeUnit

        public TimeUnit getRowExpirationTimeUnit()
        ロウの有効期限の基準とする経過期間の単位を取得します。
        Returns:
        有効期限の基準とする経過期間の単位。無設定の場合はnull
      • getSpecifiedColumns

        public java.util.Set<java.lang.String> getSpecifiedColumns()
        追加設定のあるカラムの名前をすべて取得します。

        返却されたオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

        Returns:
        追加設定のあるカラム名の集合
      • isCompressionRelative

        public java.lang.Boolean isCompressionRelative(java.lang.String column)
        指定のカラムについて、誤差あり間引き圧縮の誤差判定基準値が相対値かどうかを返します。
        Parameters:
        column - カラム名
        Returns:
        指定のカラム名に対応する設定がある場合はその設定値、ない場合はnull
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setAbsoluteHiCompression

        public void setAbsoluteHiCompression(java.lang.String column,
                                    double width)
        指定のカラムについて、絶対誤差あり間引き圧縮のパラメータを設定します。

        異なる圧縮方式が設定されていた場合、間引き圧縮設定に変更されます。

        パラメータ設定できるカラムの型、ならびに、カラム数の上限は、 setRelativeHiCompression(String, double, double)と同様です。

        Parameters:
        column - カラム名
        width - getCompressionWidth(String)と対応する誤差境界の幅
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setCompressionMethod

        public void setCompressionMethod(CompressionMethod compressionMethod)
        時系列圧縮方式の種別を設定します。

        異なる圧縮方式に変更した場合、カラム別の設定はすべて解除されます。

        Parameters:
        compressionMethod - 圧縮方式の種別
        Throws:
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setCompressionWindowSize

        public void setCompressionWindowSize(int compressionWindowSize,
                                    TimeUnit compressionWindowSizeUnit)
        間引き圧縮において、連続して間引きされるロウの最大期間を設定します。

        この期間を設定し、前方のロウと指定の期間以上時刻が離れていた場合、間引き圧縮として間引き可能な条件に達したとしても、間引きされなくなります。

        Parameters:
        compressionWindowSize - 最大連続間引き期間。0 以下の値は指定できない
        compressionWindowSizeUnit - 最大連続間引き期間を表す単位。 TimeUnit.YEARTimeUnit.MONTHは指定できない
        Throws:
        java.lang.IllegalArgumentException - 範囲外のcompressionWindowSizecompressionWindowSizeUnitが指定された場合
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setExpirationDivisionCount

        public void setExpirationDivisionCount(int count)
        有効期間に対する分割数により、期限に到達したロウデータの解放単位を設定します。

        分割数を設定すると、期限に到達したロウデータの管理領域を解放するための条件を制御できます。期限に到達したロウデータが分割数に相当する期間だけ集まった時点で解放しようとします。

        分割数の上限については、GridDBテクニカルリファレンスを参照してください。上限を超えたオプションを指定して時系列を作成することはできません。

        Parameters:
        count - 有効期間に対する分割数。0以下の値は指定できない
        Throws:
        java.lang.IllegalArgumentException - 0以下の分割数が指定された場合
        Since:
        2.0
      • setRelativeHiCompression

        public void setRelativeHiCompression(java.lang.String column,
                                    double rate,
                                    double span)
        指定のカラムについて、相対誤差あり間引き圧縮のパラメータを設定します。

        異なる圧縮方式が設定されていた場合、間引き圧縮設定に変更されます。

        ratespanの積は、絶対誤差あり間引き圧縮にて getCompressionWidth(String)により得られる値と等価です。

        パラメータ設定できるカラムの型は、以下のいずれかに限定されます。

        1つの時系列に対してパラメータ設定できるカラムの上限数については、 GridDBテクニカルリファレンスを参照してください。上限を超えるオプションは作成できますが、上限を超えたオプションを指定して時系列を作成することはできません。

        Parameters:
        column - カラム名
        rate - spanを基準とした相対誤差境界値。0 以上1以下でなければならない
        span - 対象のカラムの値がとりうる範囲の最大値と最小値の差
        Throws:
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合、また、rateに範囲外の値を指定した場合
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setRowExpiration

        public void setRowExpiration(int elapsedTime,
                            TimeUnit timeUnit)
        ロウの有効期限の基準となる経過期間を設定します。

        ロウの有効期限の時刻は、ロウキーの時刻から指定の経過期間を加算することで求まります。有効期限の時刻がGridDB上の現在時刻よりも古いロウは、有効期限の切れたロウとみなされます。期限切れのロウは、検索や更新といったロウ操作の対象から外れ、存在しないものとみなされます。対応するGridDB上の内部データは、随時削除されます。

        有効期限超過の判定に使用される現在時刻は、GridDBの各ノードの実行環境に依存します。したがって、ネットワークの遅延や実行環境の時刻設定のずれなどにより、このVMの時刻より前に期限切れ前のロウにアクセスできなくなる場合や、このVMの時刻より後に期限切れロウにアクセスできる場合があります。意図しないロウの喪失を避けるために、最低限必要な期間よりも大きな値を設定することを推奨します。

        作成済みの時系列の設定を変更することはできません。

        Parameters:
        elapsedTime - 基準とする経過期間。0以下の値は指定できない
        timeUnit - 経過期間の単位。TimeUnit.YEARTimeUnit.MONTHは指定できない
        Throws:
        java.lang.IllegalArgumentException - 範囲外のelapsedTimetimeUnitが指定された場合
        java.lang.IllegalArgumentException - 正しい形式ではないカラム名が指定された場合
        java.lang.NullPointerException - 引数にnullが指定された場合

Enum TimeUnit

  • java.lang.Object
    • java.lang.Enum<TimeUnit>
      • com.toshiba.mwcloud.gs.TimeUnit
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TimeUnit>


    public enum TimeUnit
    extends java.lang.Enum<TimeUnit>
    時系列処理で用いる時間の単位を示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static TimeUnit valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TimeUnit[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • HOUR

        public static final TimeUnit HOUR
      • MILLISECOND

        public static final TimeUnit MILLISECOND
      • MINUTE

        public static final TimeUnit MINUTE
      • MONTH

        public static final TimeUnit MONTH
      • SECOND

        public static final TimeUnit SECOND
      • YEAR

        public static final TimeUnit YEAR
    • Method Detail

      • valueOf

        public static TimeUnit valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static TimeUnit[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TimeUnit c : TimeUnit.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Class TimestampUtils

  • java.lang.Object
    • com.toshiba.mwcloud.gs.TimestampUtils


  • public class TimestampUtils
    extends java.lang.Object
    時刻データを操作するためのユーティリティ機能を提供します。
    • Constructor Summary

      Constructors 
      Constructor and Description
      TimestampUtils()
      Deprecated. 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static java.util.Date add(java.util.Date timeStamp, int amount, TimeUnit timeUnit)
      時刻に一定の値を加算します。
      static java.util.Date current()
      現在時刻を求めます。
      static java.util.Calendar currentCalendar()
      現在時刻をCalendarとして求めます。
      static java.lang.String format(java.util.Date timeStamp)
      TQLのTIMESTAMP値表記に従い、時刻の文字列表現を求めます。
      static java.text.DateFormat getFormat()
      TQLのTIMESTAMP値表記と対応する、日付フォーマットを求めます。
      static java.util.Date parse(java.lang.String source)
      TQLのTIMESTAMP値表記に従い、指定の文字列に対応するDateを求めます。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TimestampUtils

        @Deprecated
        public TimestampUtils()
        Deprecated. 
    • Method Detail

      • add

        public static java.util.Date add(java.util.Date timeStamp,
                         int amount,
                         TimeUnit timeUnit)
        時刻に一定の値を加算します。

        amountに負の値を指定することで、指定の時刻より前の時刻を求めることができます。

        現バージョンでは、算出の際に使用されるタイムゾーンはUTCです。

      • current

        public static java.util.Date current()
        現在時刻を求めます。
      • currentCalendar

        public static java.util.Calendar currentCalendar()
        現在時刻をCalendarとして求めます。

        現バージョンでは、タイムゾーンは常にUTCに設定されます。

      • format

        public static java.lang.String format(java.util.Date timeStamp)
        TQLのTIMESTAMP値表記に従い、時刻の文字列表現を求めます。

        現バージョンでは、変換の際に使用されるタイムゾーンはUTCです。

      • getFormat

        public static java.text.DateFormat getFormat()
        TQLのTIMESTAMP値表記と対応する、日付フォーマットを求めます。

        年の値が負となる時刻は扱えません。

      • parse

        public static java.util.Date parse(java.lang.String source)
                                    throws java.text.ParseException
        TQLのTIMESTAMP値表記に従い、指定の文字列に対応するDateを求めます。
        Throws:
        java.text.ParseException - 時刻の文字列表記と一致しない文字列が指定された場合

Annotation Type TransientRowField



  • @Retention(value=RUNTIME)
    @Target(value={FIELD,METHOD})
    public @interface TransientRowField
    Containerの処理において、マッピング対象外のロウフィールドであることを宣言します。

Enum TriggerInfo.EventType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TriggerInfo.EventType>
    Enclosing class:
    TriggerInfo


    public static enum TriggerInfo.EventType
    extends java.lang.Enum<TriggerInfo.EventType>
    トリガで監視対象とする更新操作種別を表します。
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      DELETE
      コンテナに対するロウ削除を示します。
      PUT
      コンテナに対するロウ新規作成または更新を示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static TriggerInfo.EventType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TriggerInfo.EventType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • DELETE

        public static final TriggerInfo.EventType DELETE
        コンテナに対するロウ削除を示します。
      • PUT

        public static final TriggerInfo.EventType PUT
        コンテナに対するロウ新規作成または更新を示します。
    • Method Detail

      • valueOf

        public static TriggerInfo.EventType valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static TriggerInfo.EventType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TriggerInfo.EventType c : TriggerInfo.EventType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Enum TriggerInfo.Type

  • java.lang.Object
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TriggerInfo.Type>
    Enclosing class:
    TriggerInfo


    public static enum TriggerInfo.Type
    extends java.lang.Enum<TriggerInfo.Type>
    トリガの種別を表します。
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      JMS
      コンテナの更新時にJava Message Service(JMS)で通知するトリガ種別を示します。
      REST
      コンテナの更新時にRESTで通知するトリガ種別を示します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static TriggerInfo.Type valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TriggerInfo.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • JMS

        public static final TriggerInfo.Type JMS
        コンテナの更新時にJava Message Service(JMS)で通知するトリガ種別を示します。
      • REST

        public static final TriggerInfo.Type REST
        コンテナの更新時にRESTで通知するトリガ種別を示します。
    • Method Detail

      • valueOf

        public static TriggerInfo.Type valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • values

        public static TriggerInfo.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TriggerInfo.Type c : TriggerInfo.Type.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared

Class TriggerInfo

  • java.lang.Object
    • com.toshiba.mwcloud.gs.TriggerInfo


  • public class TriggerInfo
    extends java.lang.Object
    コンテナの更新を監視するためのトリガ情報を表します。

    トリガ名の表記などの内容の妥当性について、必ずしも検査するとは限りません。

    Since:
    1.5
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  TriggerInfo.EventType
      トリガで監視対象とする更新操作種別を表します。
      static class  TriggerInfo.Type
      トリガの種別を表します。
    • Constructor Summary

      Constructors 
      Constructor and Description
      TriggerInfo()
      トリガ情報を生成します。
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getJMSDestinationName()
      JMS通知で使用するデスティネーション名を取得します。
      java.lang.String getJMSDestinationType()
      JMS通知で使用するデスティネーション種別を取得します。
      java.lang.String getName()
      トリガ名を取得します。
      java.lang.String getPassword()
      通知先サーバに接続する際のパスワードを取得します。
      java.util.Set<java.lang.String> getTargetColumns()
      トリガ発火時に通知対象とするカラム名を取得します。
      java.util.Set<TriggerInfo.EventType> getTargetEvents()
      トリガ発火対象とする更新操作種別を取得します。
      TriggerInfo.Type getType()
      トリガ種別を取得します。
      java.net.URI getURI()
      トリガ発火時の通知先URIを取得します。
      java.lang.String getUser()
      通知先サーバに接続する際のユーザ名を取得します。
      void setJMSDestinationName(java.lang.String destinationName)
      JMS通知で使用するデスティネーション名を設定します。
      void setJMSDestinationType(java.lang.String destinationType)
      JMS通知で使用するデスティネーション種別を設定します。
      void setName(java.lang.String name)
      トリガ名を設定します。
      void setPassword(java.lang.String password)
      通知先サーバに接続する際のパスワードを設定します。
      void setTargetColumns(java.util.Set<java.lang.String> columnSet)
      トリガ発火時に通知対象とするカラム名を設定します。
      void setTargetEvents(java.util.Set<TriggerInfo.EventType> eventSet)
      トリガ発火対象とする更新操作種別を設定します。
      void setType(TriggerInfo.Type type)
      トリガ種別を設定します。
      void setURI(java.net.URI uri)
      トリガ発火時の通知先URIを設定します。
      void setUser(java.lang.String user)
      通知先サーバに接続する際のユーザ名を設定します。
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TriggerInfo

        public TriggerInfo()
        トリガ情報を生成します。
    • Method Detail

      • getJMSDestinationName

        public java.lang.String getJMSDestinationName()
        JMS通知で使用するデスティネーション名を取得します。
      • getJMSDestinationType

        public java.lang.String getJMSDestinationType()
        JMS通知で使用するデスティネーション種別を取得します。
      • getName

        public java.lang.String getName()
        トリガ名を取得します。
      • getPassword

        public java.lang.String getPassword()
        通知先サーバに接続する際のパスワードを取得します。

        現バージョンでは、JMS通知でJMSサーバへ接続する場合にのみ使用されます。

      • getTargetColumns

        public java.util.Set<java.lang.String> getTargetColumns()
        トリガ発火時に通知対象とするカラム名を取得します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

      • getTargetEvents

        public java.util.Set<TriggerInfo.EventType> getTargetEvents()
        トリガ発火対象とする更新操作種別を取得します。

        返却された値に対して変更操作を行った場合、 UnsupportedOperationExceptionが発生することがあります。また、このオブジェクトに対する操作により、返却されたオブジェクトの内容が変化することはありません。

      • getType

        public TriggerInfo.Type getType()
        トリガ種別を取得します。
      • getURI

        public java.net.URI getURI()
        トリガ発火時の通知先URIを取得します。
      • getUser

        public java.lang.String getUser()
        通知先サーバに接続する際のユーザ名を取得します。

        現バージョンでは、JMS通知でJMSサーバへ接続する場合にのみ使用されます。

      • setJMSDestinationName

        public void setJMSDestinationName(java.lang.String destinationName)
        JMS通知で使用するデスティネーション名を設定します。

        nullが指定された場合、 Container.createTrigger(TriggerInfo)の実行時にエラーとなります。

      • setJMSDestinationType

        public void setJMSDestinationType(java.lang.String destinationType)
        JMS通知で使用するデスティネーション種別を設定します。

        "queue"または"topic"が指定できます。大文字小文字は同一視されません。

        "queue"または"topic"以外が指定された場合、 Container.createTrigger(TriggerInfo)の実行時にエラーとなります。

      • setName

        public void setName(java.lang.String name)
        トリガ名を設定します。

        空文字列・nullが設定された場合、 Container.createTrigger(TriggerInfo)の実行時にエラーとなります。

      • setPassword

        public void setPassword(java.lang.String password)
        通知先サーバに接続する際のパスワードを設定します。

        現バージョンでは、JMS通知でJMSサーバへ接続する場合にのみ使用されます。

        設定がない、または空文字列・nullが設定された場合、空文字列をパスワードとして使用し接続します。

        ユーザ名・パスワードとも設定がない、または空文字列・nullが設定された場合、ユーザ名・パスワードを使用せずに接続します。

      • setTargetColumns

        public void setTargetColumns(java.util.Set<java.lang.String> columnSet)
        トリガ発火時に通知対象とするカラム名を設定します。

        カラム名の大文字小文字は同一視されます。同一カラム名を複数設定してもそのカラムの値は通知には一度しか設定されません。

        カラム名の指定がない場合、通知にはいずれのカラムの値も設定されません。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Throws:
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setTargetEvents

        public void setTargetEvents(java.util.Set<TriggerInfo.EventType> eventSet)
        トリガ発火対象とする更新操作種別を設定します。

        複数の更新操作を設定した場合は、そのいずれかが行われた場合にトリガが発火します。

        更新操作の設定がない場合、 Container.createTrigger(TriggerInfo)の実行時にエラーとなります。

        指定したオブジェクトの内容を呼び出し後に変更したとしても、このオブジェクトの内容は変化しません。

        Throws:
        java.lang.NullPointerException - 引数にnullが指定された場合
      • setURI

        public void setURI(java.net.URI uri)
        トリガ発火時の通知先URIを設定します。

        nullが設定された場合、 Container.createTrigger(TriggerInfo)の実行時にエラーとなります。

      • setUser

        public void setUser(java.lang.String user)
        通知先サーバに接続する際のユーザ名を設定します。

        現バージョンでは、JMS通知でJMSサーバへ接続する場合にのみ使用されます。

        設定がない、または空文字列・nullが設定された場合、空文字列をユーザ名として使用し接続します。

        ユーザ名・パスワードとも設定がない、または空文字列・null が設定された場合、ユーザ名・パスワードを使用せずに接続します。

Serialized Form

  • Package com.toshiba.mwcloud.gs

    • Class com.toshiba.mwcloud.gs.GSException extends java.io.IOException implements Serializable

      serialVersionUID:
      -7261622831192521426L
      • Serialized Fields

        • errorCode

          int errorCode
        • errorName

          java.lang.String errorName
        • description

          java.lang.String description
    • Class com.toshiba.mwcloud.gs.GSRecoverableException extends GSException implements Serializable

      serialVersionUID:
      1241771194878438360L
    • Class com.toshiba.mwcloud.gs.GSTimeoutException extends GSException implements Serializable

      serialVersionUID:
      -2321647495394140580L

5.2 APIサンプル(Java)

5.2.1 コレクション操作のサンプル(Java)

?package test;


import java.util.Arrays;
import java.util.Properties;

import com.toshiba.mwcloud.gs.Collection;
import com.toshiba.mwcloud.gs.GSException;
import com.toshiba.mwcloud.gs.GridStore;
import com.toshiba.mwcloud.gs.GridStoreFactory;
import com.toshiba.mwcloud.gs.Query;
import com.toshiba.mwcloud.gs.RowKey;
import com.toshiba.mwcloud.gs.RowSet;


// コレクションデータの操作
public class Sample1 {

	static class Person {
		@RowKey String name;
		boolean status;
		long count;
		byte[] lob;
	}

	public static void main(String[] args) throws GSException {

		// グリッドストアの取得
		Properties props = new Properties();
		props.setProperty("notificationAddress", args[0]);
		props.setProperty("notificationPort", args[1]);
		props.setProperty("clusterName", args[2]);
		props.setProperty("user", "system");
		props.setProperty("password", "manager");
		GridStore store = GridStoreFactory.getInstance().getGridStore(props);

		// コレクションの作成
		Collection<String, Person> col = store.putCollection("col01", Person.class);

		// ロウキーのカラムに索引を設定
		col.createIndex("name");

		// カラムに索引を設定
		col.createIndex("count");

		// 自動コミットモードをオフ
		col.setAutoCommit(false);

		// Rowのデータを用意
		Person person = new Person();
		person.name = "name01";
		person.status = false;
		person.count = 1;
		person.lob = new byte[] { 65, 66, 67, 68, 69, 70, 71, 72, 73, 74 };

		// KV形式でRowを操作: RowKeyは"name01"
		boolean update = true;
		col.put(person);	// 登録
		person = col.get(person.name, update);	// 取得(更新用にロック)
		col.remove(person.name);	// 削除

		// KV形式でRowを操作: RowKeyは"name02"
		col.put("name02", person);	// 登録(RowKeyを指定)

		// トランザクションの確定(ロック解除)
		col.commit();

		// コレクション内のRowを検索
		Query<Person> query = col.query("select * where name = 'name02'");

		// 検索したRowの取得と更新
		RowSet<Person> rs = query.fetch(update);
		while (rs.hasNext()) {
			// 検索したRowの更新
			Person person1 = rs.next();
			person1.count += 1;
			rs.update(person1);

			System.out.println("Person: " +
					" name=" + person1.name +
					" status=" + person1.status +
					" count=" + person1.count +
					" lob=" + Arrays.toString(person1.lob));
		}

		// トランザクションの確定
		col.commit();

		// リソースの解放
		store.close();
	}

}

5.2.2 時系列操作のサンプル — 登録・範囲取得(Java)

?package test;


import java.util.Date;
import java.util.Properties;

import com.toshiba.mwcloud.gs.GSException;
import com.toshiba.mwcloud.gs.GridStore;
import com.toshiba.mwcloud.gs.GridStoreFactory;
import com.toshiba.mwcloud.gs.RowKey;
import com.toshiba.mwcloud.gs.RowSet;
import com.toshiba.mwcloud.gs.TimeSeries;
import com.toshiba.mwcloud.gs.TimestampUtils;
import com.toshiba.mwcloud.gs.TimeUnit;


// 時系列データの登録と範囲取得
public class Sample2 {

	static class Point {
		@RowKey Date timestamp;
		boolean active;
		double voltage;
	}

	public static void main(String[] args) throws GSException {

		// グリッドストアの取得
		Properties props = new Properties();
		props.setProperty("notificationAddress", args[0]);
		props.setProperty("notificationPort", args[1]);
		props.setProperty("clusterName", args[2]);
		props.setProperty("user", "system");
		props.setProperty("password", "manager");
		GridStore store = GridStoreFactory.getInstance().getGridStore(props);

		// 時系列の作成 (既存の場合は取得のみ)
		TimeSeries<Point> ts = store.putTimeSeries("point01", Point.class);

		// 時系列要素のデータを用意
		Point point = new Point();
		point.active = false;
		point.voltage = 100;

		// 時系列要素の登録(グリッドストア側で時刻設定)
		ts.append(point);

		// 指定区間の時系列の取得: 6時間前から直近まで
		Date now = TimestampUtils.current();
		Date before = TimestampUtils.add(now, -6, TimeUnit.HOUR);

		RowSet<Point> rs = ts.query(before, now).fetch();

		while (rs.hasNext()) {
			point = rs.next();

			System.out.println(
					"Time=" + TimestampUtils.format(point.timestamp) +
					" Active=" + point.active +
					" Voltage=" + point.voltage);
		}

		// リソースの解放
		store.close();
	}

}

5.2.3 時系列操作のサンプル — 検索・集計(Java)

?package test;


import java.util.Date;
import java.util.Properties;

import com.toshiba.mwcloud.gs.Aggregation;
import com.toshiba.mwcloud.gs.AggregationResult;
import com.toshiba.mwcloud.gs.GSException;
import com.toshiba.mwcloud.gs.GridStore;
import com.toshiba.mwcloud.gs.GridStoreFactory;
import com.toshiba.mwcloud.gs.Query;
import com.toshiba.mwcloud.gs.RowKey;
import com.toshiba.mwcloud.gs.RowSet;
import com.toshiba.mwcloud.gs.TimeOperator;
import com.toshiba.mwcloud.gs.TimeSeries;
import com.toshiba.mwcloud.gs.TimestampUtils;
import com.toshiba.mwcloud.gs.TimeUnit;


// 時系列データの検索と集計
public class Sample3 {

	static class Point {
		@RowKey Date timestamp;
		boolean active;
		double voltage;
	}

	public static void main(String[] args) throws GSException {

		// 読み取りのみなので、一貫性レベルを緩和(デフォルトはIMMEDIATE)
		Properties props = new Properties();
		props.setProperty("notificationAddress", args[0]);
		props.setProperty("notificationPort", args[1]);
		props.setProperty("clusterName", args[2]);
		props.setProperty("user", "system");
		props.setProperty("password", "manager");
		props.setProperty("consistency", "EVENTUAL");

		// グリッドストアの取得
		GridStore store = GridStoreFactory.getInstance().getGridStore(props);

		// 時系列の取得
		// ※Sample2と同じPointクラスを使用
		TimeSeries<Point> ts = store.getTimeSeries("point01", Point.class);

		// 停止中にもかかわらず電圧が基準値以上の箇所を検索
		Query<Point> query = ts.query(
				"select * from point01" +
				" where not active and voltage > 50");
		RowSet<Point> rs = query.fetch();

		while (rs.hasNext()) {
			// 各異常ポイントについて調査

			Point hotPoint = rs.next();
			Date hot = hotPoint.timestamp;

			// 10分前付近のデータを取得
			Date start = TimestampUtils.add(hot, -10, TimeUnit.MINUTE);
			Point startPoint = ts.get(start, TimeOperator.NEXT);

			// 前後10分間の平均値を計算
			Date end = TimestampUtils.add(hot, 10, TimeUnit.MINUTE);
			AggregationResult avg =
				ts.aggregate(start, end, "voltage", Aggregation.AVERAGE);

			System.out.println(
					"[Alert] " + TimestampUtils.format(hot) +
					" start=" + startPoint.voltage +
					" hot=" + hotPoint.voltage +
					" avg=" + avg.getDouble());
		}

		// リソースの解放
		store.close();
	}

}

6 API (C言語)

6.1 API一覧(C言語)

C API

GridDBの公開C言語インタフェースを定義します

gridstore.h File Reference

GridDBのC言語向け公開API. More...

#include <stdlib.h>
#include <stdint.h>

Classes

struct  GSBlobTag
 ロウオブジェクトにおけるBLOB構造を表します。More...
 
struct  GSPropertyEntryTag
 プロパティの構成エントリです。More...
 
struct  GSColumnCompressionTag
 特定のカラムの圧縮設定を表します。More...
 
struct  GSCollectionPropertiesTag
 コレクションの構成オプションを表します。More...
 
struct  GSTimeSeriesPropertiesTag
 時系列を新規作成または変更する際に使用される、オプションの構成情報を表します。More...
 
struct  GSColumnInfoTag
 カラムのスキーマに関する情報を表します。More...
 
struct  GSTriggerInfoTag
 トリガに関する情報を表します。More...
 
struct  GSIndexInfoTag
 
struct  GSContainerInfoTag
 特定のコンテナに関する情報を表します。More...
 
struct  GSBindingTag
 ロウオブジェクトとロウデータとの対応関係を表すバインディング情報です。More...
 
struct  GSQueryAnalysisEntryTag
 クエリプランならびにクエリ処理解析結果を構成する一連の情報の一つを示します。More...
 
struct  GSContainerRowEntryTag
 複数のコンテナの複数のロウを一括して操作する場合に用いる、コンテナ別のロウ内容エントリです。More...
 
struct  GSRowKeyPredicateEntryTag
 複数のコンテナに対する取得条件を表すための、コンテナ別の合致条件エントリです。More...
 
union  GSValueTag
 ロウフィールドに格納できるいずれかの型の値です。More...
 

Macros

#define GS_CLIENT_VERSION_MAJOR   3
 GridDBクライアントのメジャーバージョンを表す数値です。
 
#define GS_CLIENT_VERSION_MINOR   3
 GridDBクライアントのマイナーバージョンを表す数値です。
 
#define GS_TRUE   1
 真であることを示すブール型値です。
 
#define GS_FALSE   0
 偽であることを示すブール型値です。
 
#define GS_RESULT_OK   0
 GridDBに対する命令の実行に成功したことを示す、実行結果コードの値です。More...
 
#define GS_SUCCEEDED(result)   ((result) == GS_RESULT_OK)
 実行結果コードに基づきGridDBに対する命令の実行に成功したかどうかのブール値を求めるマクロです。More...
 
#define GS_COLUMN_COMPRESSION_INITIALIZER   { NULL, GS_FALSE, 0, 0, 0 }
 GSColumnCompressionの初期化子です。
 
#define GS_COLLECTION_PROPERTIES_INITIALIZER   { 0 }
 GSCollectionPropertiesの初期化子です。
 
#define GS_TIME_SERIES_PROPERTIES_INITIALIZER
 GSTimeSeriesPropertiesの初期化子です。More...
 
#define GS_COLUMN_INFO_INITIALIZER   { NULL, GS_TYPE_STRING, GS_INDEX_FLAG_DEFAULT, 0 }
 GSColumnInfoの初期化子です。
 
#define GS_TRIGGER_INFO_INITIALIZER
 GSTriggerInfoの初期化子です。
 
#define GS_INDEX_INFO_INITIALIZER   { NULL, GS_INDEX_FLAG_DEFAULT, -1, NULL }
 
#define GS_CONTAINER_INFO_INITIALIZER
 GSContainerInfoの初期化子です。
 
#define GS_QUERY_ANALYSIS_ENTRY_INITIALIZER   { 0, 0, NULL, NULL, NULL, NULL }
 GSQueryAnalysisEntryの初期化子です。
 
#define GS_CONTAINER_ROW_ENTRY_INITIALIZER   { NULL, NULL, NULL }
 GSContainerRowEntryの初期化子です。More...
 
#define GS_ROW_KEY_PREDICATE_ENTRY_INITIALIZER   { NULL, NULL }
 GSRowKeyPredicateEntryの初期化子です。More...
 
#define GS_TIME_STRING_SIZE_MAX   32
 TIMESTAMP型値の文字列表現を格納するための文字列バッファにおける、終端文字を含むバイト単位での最大サイズです。More...
 
#define GS_GET_STRUCT_BINDING(type)   gsSetupStructBindingOf_##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...
 

Typedefs

typedef char GSChar
 GridDB APIで使用される標準の文字の型です。More...
 
typedef char GSBool
 GridDB APIで使用されるブール型です。More...
 
typedef int32_t GSEnum
 列挙型
 
typedef int64_t GSTimestamp
 GridDB上のTIMESTAMP型と対応する時刻型です。ミリ秒単位のUNIX時刻を保持します。
 
typedef struct
GSGridStoreFactoryTag 
GSGridStoreFactory
 GSGridStoreインスタンスを管理します。More...
 
typedef struct GSGridStoreTag GSGridStore
 1つのGridDBシステムが管理するデータ全体を操作するための機能を提供します。More...
 
typedef struct GSContainerTag GSContainer
 同一タイプのロウ集合からなるGridDBの構成要素に対しての、管理機能を提供します。More...
 
typedef struct GSQueryTag GSQuery
 特定のGSContainerに対応付けられたクエリを保持し、結果取得方法の設定ならびに実行・結果取得を行う機能を持ちます。
 
typedef struct GSRowSetTag GSRowSet
 クエリ実行より求めたロウの集合を管理します。More...
 
typedef struct
GSAggregationResultTag 
GSAggregationResult
 集計演算の結果を保持します。More...
 
typedef GSContainer GSCollection
 ロウ集合を汎用的に管理するためのコンテナです。More...
 
typedef GSContainer GSTimeSeries
 時刻をロウキーとする、時系列処理に特化したコンテナです。More...
 
typedef struct GSRowTag GSRow
 任意のスキーマについて汎用的にフィールド操作できるロウです。More...
 
typedef struct GSRowKeyPredicateTag GSRowKeyPredicate
 ロウキーの合致条件を表します。More...
 
typedef struct
GSPartitionControllerTag 
GSPartitionController
 パーティション状態の取得や操作のためのコントローラです。More...
 
typedef int32_t GSResult
 GridDBに対する命令の実行結果コードの型です。
 
typedef struct GSBlobTag GSBlob
 ロウオブジェクトにおけるBLOB構造を表します。
 
typedef struct GSPropertyEntryTag GSPropertyEntry
 プロパティの構成エントリです。
 
typedef GSEnum GSFetchOption
 
typedef GSEnum GSQueryOrder
 
typedef int32_t GSIndexTypeFlags
 
typedef GSEnum GSAggregation
 
typedef GSEnum GSInterpolationMode
 
typedef GSEnum GSTimeOperator
 
typedef GSEnum GSGeometryOperator
 
typedef GSEnum GSCompressionMethod
 
typedef GSEnum GSTimeUnit
 
typedef GSEnum GSContainerType
 
typedef GSEnum GSType
 
typedef int32_t GSTypeOption
 
typedef GSEnum GSRowSetType
 
typedef struct
GSColumnCompressionTag 
GSColumnCompression
 特定のカラムの圧縮設定を表します。More...
 
typedef struct
GSCollectionPropertiesTag 
GSCollectionProperties
 コレクションの構成オプションを表します。More...
 
typedef struct
GSTimeSeriesPropertiesTag 
GSTimeSeriesProperties
 時系列を新規作成または変更する際に使用される、オプションの構成情報を表します。
 
typedef struct GSColumnInfoTag GSColumnInfo
 カラムのスキーマに関する情報を表します。
 
typedef GSEnum GSTriggerType
 
typedef int32_t GSTriggerEventTypeFlags
 
typedef struct GSTriggerInfoTag GSTriggerInfo
 トリガに関する情報を表します。More...
 
typedef struct GSIndexInfoTag GSIndexInfo
 
typedef struct GSContainerInfoTag GSContainerInfo
 特定のコンテナに関する情報を表します。
 
typedef struct GSBindingTag GSBinding
 ロウオブジェクトとロウデータとの対応関係を表すバインディング情報です。
 
typedef struct
GSQueryAnalysisEntryTag 
GSQueryAnalysisEntry
 クエリプランならびにクエリ処理解析結果を構成する一連の情報の一つを示します。More...
 
typedef struct
GSContainerRowEntryTag 
GSContainerRowEntry
 複数のコンテナの複数のロウを一括して操作する場合に用いる、コンテナ別のロウ内容エントリです。More...
 
typedef struct
GSRowKeyPredicateEntryTag 
GSRowKeyPredicateEntry
 複数のコンテナに対する取得条件を表すための、コンテナ別の合致条件エントリです。More...
 
typedef union GSValueTag GSValue
 ロウフィールドに格納できるいずれかの型の値です。More...
 

Enumerations

enum  GSFetchOptionTag { GS_FETCH_LIMIT }
 クエリ実行結果を取得する際のオプション項目です。More...
 
enum  GSQueryOrderTag { GS_ORDER_ASCENDING, GS_ORDER_DESCENDING }
 クエリにおける要求ロウ順序を表します。More...
 
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  GSAggregationTag {
  GS_AGGREGATION_MINIMUM, GS_AGGREGATION_MAXIMUM, GS_AGGREGATION_TOTAL, GS_AGGREGATION_AVERAGE,
  GS_AGGREGATION_VARIANCE, GS_AGGREGATION_STANDARD_DEVIATION, GS_AGGREGATION_COUNT, GS_AGGREGATION_WEIGHTED_AVERAGE
}
 ロウ集合またはその特定のカラムに対する、集計演算の方法を示します。More...
 
enum  GSInterpolationModeTag { GS_INTERPOLATION_LINEAR_OR_PREVIOUS, GS_INTERPOLATION_EMPTY }
 ロウの補間方法の種別を表します。More...
 
enum  GSTimeOperatorTag { GS_TIME_OPERATOR_PREVIOUS, GS_TIME_OPERATOR_PREVIOUS_ONLY, GS_TIME_OPERATOR_NEXT, GS_TIME_OPERATOR_NEXT_ONLY }
 GSTimeSeriesのキー時刻に基づく、ロウの特定方法を表します。More...
 
enum  GSGeometryOperatorTag { GS_GEOMETRY_OPERATOR_INTERSECT }
 空間範囲同士の関係性についての制約を定義します。More...
 
enum  GSCompressionMethodTag { GS_COMPRESSION_NO, GS_COMPRESSION_SS, GS_COMPRESSION_HI }
 圧縮方式の種別を表します。More...
 
enum  GSTimeUnitTag {
  GS_TIME_UNIT_YEAR, GS_TIME_UNIT_MONTH, GS_TIME_UNIT_DAY, GS_TIME_UNIT_HOUR,
  GS_TIME_UNIT_MINUTE, GS_TIME_UNIT_SECOND, GS_TIME_UNIT_MILLISECOND
}
 時系列処理で用いる時間の単位を示します。More...
 
enum  GSContainerTypeTag { GS_CONTAINER_COLLECTION, GS_CONTAINER_TIME_SERIES }
 コンテナの種別を表します。More...
 
enum  GSTypeTag {
  GS_TYPE_STRING, GS_TYPE_BOOL, GS_TYPE_BYTE, GS_TYPE_SHORT,
  GS_TYPE_INTEGER, GS_TYPE_LONG, GS_TYPE_FLOAT, GS_TYPE_DOUBLE,
  GS_TYPE_TIMESTAMP, GS_TYPE_GEOMETRY, GS_TYPE_BLOB, GS_TYPE_STRING_ARRAY,
  GS_TYPE_BOOL_ARRAY, GS_TYPE_BYTE_ARRAY, GS_TYPE_SHORT_ARRAY, GS_TYPE_INTEGER_ARRAY,
  GS_TYPE_LONG_ARRAY, GS_TYPE_FLOAT_ARRAY, GS_TYPE_DOUBLE_ARRAY, GS_TYPE_TIMESTAMP_ARRAY,
  GS_TYPE_NULL = -1
}
 GridDB上のフィールド値の型を表します。More...
 
enum  GSTypeOptionTag { GS_TYPE_OPTION_NULLABLE = 1 << 1, GS_TYPE_OPTION_NOT_NULL = 1 << 2 }
 
enum  GSRowSetTypeTag { GS_ROW_SET_CONTAINER_ROWS, GS_ROW_SET_AGGREGATION_RESULT, GS_ROW_SET_QUERY_ANALYSIS }
 GSRowSetから取り出すことのできる内容の種別です。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

GS_DLL_PUBLIC void GS_API_CALL gsCloseFactory (GSGridStoreFactory **factory, GSBool allRelated)
 必要に応じ、指定のGSGridStoreFactoryに関連するリソースをクローズします。More...
 
GS_DLL_PUBLIC
GSGridStoreFactory
*GS_API_CALL 
gsGetDefaultFactory ()
 デフォルトのGSGridStoreFactoryインスタンスを取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetGridStore (GSGridStoreFactory *factory, const GSPropertyEntry *properties, size_t propertyCount, GSGridStore **store)
 指定のプロパティを持つGSGridStoreを取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetFactoryProperties (GSGridStoreFactory *factory, const GSPropertyEntry *properties, size_t propertyCount)
 指定のファクトリの設定を変更します。More...
 
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_DLL_PUBLIC GSResult GS_API_CALL 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_DLL_PUBLIC GSResult GS_API_CALL gsGetTimeSeries (GSGridStore *store, const GSChar *name, const GSBinding *binding, GSTimeSeries **timeSeries)
 指定の名前の時系列を操作するためのGSTimeSeriesインスタンスを取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsPutContainer (GSGridStore *store, const GSChar *name, const GSBinding *binding, const GSContainerInfo *info, GSBool modifiable, GSContainer **container)
 バインディング情報とGSContainerInfoを指定して、コンテナを新規作成または変更します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL 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 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 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_DLL_PUBLIC GSResult GS_API_CALL gsCreateIndexDetail (GSContainer *container, const GSIndexInfo *info)
 
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_DLL_PUBLIC GSResult GS_API_CALL gsDropIndexDetail (GSContainer *container, const GSIndexInfo *info)
 
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 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 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 gsDeleteRowByString (GSContainer *container, const GSChar *key, GSBool *exists)
 STRING型のロウキーに対応するロウを削除します。More...
 
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...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsAggregateTimeSeries (GSTimeSeries *timeSeries, GSTimestamp start, GSTimestamp end, const GSChar *column, GSAggregation aggregation, GSAggregationResult **aggregationResult)
 開始・終了時刻を指定して、ロウ集合またはその特定のカラムに対し集計演算を行います。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsAppendTimeSeriesRow (GSTimeSeries *timeSeries, const void *rowObj, GSBool *exists)
 GridDB上の現在時刻をロウキーとして、ロウを新規作成または更新します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowByBaseTime (GSTimeSeries *timeSeries, GSTimestamp base, GSTimeOperator timeOp, void *rowObj, GSBool *exists)
 指定の時刻を基準として、関係する1つのロウを取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsInterpolateTimeSeriesRow (GSTimeSeries *timeSeries, GSTimestamp base, const GSChar *column, void *rowObj, GSBool *exists)
 指定時刻に相当するロウオブジェクトについて、線形補間などを行い生成します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsQueryByTimeSeriesRange (GSTimeSeries *timeSeries, GSTimestamp start, GSTimestamp end, GSQuery **query)
 開始時刻・終了時刻を指定して、特定範囲のロウ集合を求めるクエリを作成します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsQueryByTimeSeriesOrderedRange (GSTimeSeries *timeSeries, const GSTimestamp *start, const GSTimestamp *end, GSQueryOrder order, GSQuery **query)
 開始時刻・終了時刻・順序を指定して、特定範囲のロウ集合を求めるクエリを作成します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsQueryByTimeSeriesSampling (GSTimeSeries *timeSeries, GSTimestamp start, GSTimestamp end, const GSChar *const *columnSet, size_t columnCount, GSInterpolationMode mode, int32_t interval, GSTimeUnit intervalUnit, GSQuery **query)
 特定範囲のロウ集合をサンプリングするクエリを作成します。More...
 
GS_DLL_PUBLIC void GS_API_CALL gsCloseRow (GSRow **row)
 指定のGSRowインスタンスを解放します。More...
 
GS_STATIC_HEADER_FUNC_SPECIFIER
GSResult 
gsGetRowSchema (GSRow *row, GSContainerInfo *schemaInfo)
 指定のロウに対応するスキーマを取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldGeneral (GSRow *row, int32_t column, const GSValue *fieldValue, GSType type)
 指定のフィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldGeneral (GSRow *row, int32_t column, GSValue *fieldValue, GSType *type)
 指定のフィールドの値とその型を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldNull (GSRow *row, int32_t column)
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldNull (GSRow *row, int32_t column, GSBool *nullValue)
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByString (GSRow *row, int32_t column, const GSChar *fieldValue)
 指定のSTRING型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsString (GSRow *row, int32_t column, const GSChar **fieldValue)
 指定のSTRING型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByBool (GSRow *row, int32_t column, GSBool fieldValue)
 指定のBOOL型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsBool (GSRow *row, int32_t column, GSBool *fieldValue)
 指定のBOOL型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByByte (GSRow *row, int32_t column, int8_t fieldValue)
 指定のBYTE型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsByte (GSRow *row, int32_t column, int8_t *fieldValue)
 指定のBYTE型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByShort (GSRow *row, int32_t column, int16_t fieldValue)
 指定のSHORT型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsShort (GSRow *row, int32_t column, int16_t *fieldValue)
 指定のSHORT型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByInteger (GSRow *row, int32_t column, int32_t fieldValue)
 指定のINTEGER型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsInteger (GSRow *row, int32_t column, int32_t *fieldValue)
 指定のINTEGER型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByLong (GSRow *row, int32_t column, int64_t fieldValue)
 指定のLONG型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsLong (GSRow *row, int32_t column, int64_t *fieldValue)
 指定のLONG型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByFloat (GSRow *row, int32_t column, float fieldValue)
 指定のFLOAT型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsFloat (GSRow *row, int32_t column, float *fieldValue)
 指定のFLOAT型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByDouble (GSRow *row, int32_t column, double fieldValue)
 指定のDOUBLE型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsDouble (GSRow *row, int32_t column, double *fieldValue)
 指定のDOUBLE型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByTimestamp (GSRow *row, int32_t column, GSTimestamp fieldValue)
 指定のTIMESTAMP型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsTimestamp (GSRow *row, int32_t column, GSTimestamp *fieldValue)
 指定のTIMESTAMP型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByGeometry (GSRow *row, int32_t column, const GSChar *fieldValue)
 指定のGEOMETRY型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsGeometry (GSRow *row, int32_t column, const GSChar **fieldValue)
 指定のGEOMETRY型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByBlob (GSRow *row, int32_t column, const GSBlob *fieldValue)
 指定のBLOB型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsBlob (GSRow *row, int32_t column, GSBlob *fieldValue)
 指定のBLOB型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByStringArray (GSRow *row, int32_t column, const GSChar *const *fieldValue, size_t size)
 指定のSTRING配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsStringArray (GSRow *row, int32_t column, const GSChar *const **fieldValue, size_t *size)
 指定のSTRING配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByBoolArray (GSRow *row, int32_t column, const GSBool *fieldValue, size_t size)
 指定のBOOL配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsBoolArray (GSRow *row, int32_t column, const GSBool **fieldValue, size_t *size)
 指定のBOOL配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByByteArray (GSRow *row, int32_t column, const int8_t *fieldValue, size_t size)
 指定のBYTE配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsByteArray (GSRow *row, int32_t column, const int8_t **fieldValue, size_t *size)
 指定のBYTE配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByShortArray (GSRow *row, int32_t column, const int16_t *fieldValue, size_t size)
 指定のSHORT配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsShortArray (GSRow *row, int32_t column, const int16_t **fieldValue, size_t *size)
 指定のSHORT配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByIntegerArray (GSRow *row, int32_t column, const int32_t *fieldValue, size_t size)
 指定のINTEGER配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsIntegerArray (GSRow *row, int32_t column, const int32_t **fieldValue, size_t *size)
 指定のINTEGER配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByLongArray (GSRow *row, int32_t column, const int64_t *fieldValue, size_t size)
 指定のLONG配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsLongArray (GSRow *row, int32_t column, const int64_t **fieldValue, size_t *size)
 指定のLONG配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByFloatArray (GSRow *row, int32_t column, const float *fieldValue, size_t size)
 指定のFLOAT配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsFloatArray (GSRow *row, int32_t column, const float **fieldValue, size_t *size)
 指定のFLOAT配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByDoubleArray (GSRow *row, int32_t column, const double *fieldValue, size_t size)
 指定のDOUBLE配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsDoubleArray (GSRow *row, int32_t column, const double **fieldValue, size_t *size)
 指定のDOUBLE配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsSetRowFieldByTimestampArray (GSRow *row, int32_t column, const GSTimestamp *fieldValue, size_t size)
 指定のTIMESTAMP配列型フィールドに値を設定します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsGetRowFieldAsTimestampArray (GSRow *row, int32_t column, const GSTimestamp **fieldValue, size_t *size)
 指定のTIMESTAMP配列型フィールドの値を取得します。More...
 
GS_DLL_PUBLIC void GS_API_CALL gsCloseQuery (GSQuery **query)
 指定のGSQueryインスタンスを解放します。More...
 
GS_DLL_PUBLIC GSResult GS_API_CALL gsFetch (GSQuery *query, GSBool forUpdate, GSRowSet **rowSet)