GaroonGet - Garoonからの入力

GaroonへSELECT文を発行して結果セットをストリームとして出力します。

GaroonへのアクセスはCData Software Inc.社の提供する技術を利用してRDBのようにSQLでアクセスする手段を提供します。利用できるSQLなどの詳細についてはこちらも参考にしてください。

その他CDataアダプターをご利用する際の注意事項に関してはこちらをご覧ください。

ストリーム情報

入力フォーマットすべて
接続数無制限
説明

入力ストリームは使用せず、すべて無視します。

出力フォーマットRecord

コンポーネントプロパティ

名前データ型マッピング説明
コネクション名connection- 接続先のGaroonを指定します。 コネクションペインまたは管理コンソールにて作成されたGaroon接続名を選択します。
SQL文stringIn & Out 実際にGaroonに対して発行されるSQLを指定します。
SQLビルダーによって自動作成したり、さらに編集したりすることができます。詳細については下記トピック「SQLビルダーの使い方」を参照してください。SQLビルダーを使わずに、前に連結したマッパーからSQL文の文字列をマッピングすることもできます。
フィルターを指定boolean- 取得した結果セットに対して読込み開始行取出す件数でフィルタリングを行うかどうかを指定します。
はい [true] - 結果セットを読込み開始行取出す件数でフィルタリングします。
いいえ [false] - 結果セットのフィルタリングは行われません。
読込み開始行intIn & Outフィルターを指定が「はい」の場合に出力するレコードの開始行を指定します。
行のインデックスは1ベースのインデックスです。
読込み開始行が結果セットの件数よりも大きい場合はレコードが無いが発生します。(レコードが無い場合エラーが「いいえ」の場合は空の結果セットが出力されます。)
取出す件数intIn & Outフィルターを指定が「はい」の場合に出力するレコードの行数を指定します。
例えば読込み開始行=11、取出す件数=10の場合は入力レコードセットの11行目から10行が出力されます。
取出す件数に達する前に入力レコードが最終行に達した場合はそこまでのレコードが出力されます。
取出す件数が0の場合は、読込み開始行以降のすべての行が出力されます。
タイムアウト(秒)intIn & Out GaroonへSELECT文を発行してから結果が返ってくるまでの待ち時間を秒単位で指定します。
指定時間を経過しても実行が終わらない場合は汎用となります。
0の場合はタイムアウトすることはありません。
ループを開始loopProcess- 結果セットをまとめて出力するかループ時に取出す件数での指定行数ずつループして出力するかを選択します。
はい [true] - ループの起点となって1レコードずつストリームに出力します。
いいえ [false] - すべてのレコードがまとめてストリームに出力します。
ループ時に取出す件数intIn & Outループを開始はいの場合に一度の実行で出力する行数を指定します。
レコードが無い場合エラーboolean- 結果セットのレコード件数が0件だった場合にエラーを発生するかどうかを選択します。
はい [true] - エラーを発生します。
いいえ [false] - 空のストリームを出力します。
トランザクションに含めるboolean- このプロパティの値は無視されます。
はい [true] - コンポーネントの処理をトランザクションに含めます。
いいえ [false] - コンポーネントの処理をトランザクションに含めません。
フェッチサイズint- JDBCのsetFetchSize()に設定する値を指定します。
SQLパラメーターを使用するboolean- $,? をSQL文で使用したいときにこのプロパティを「いいえ」にするとSQLパラメーター置換処理をせずコンポーネントを実行できます。 また、この場合はSQLパラメーターが設定されていても無視されるので注意してください。
はい [true] - SQL文のSQLパラメーター書式の文字を置換します。
いいえ [false] - SQL文のSQLパラメーター書式の文字を置換をしません。
SQLパラメーターcategoryIn & OutSQL文中にパラメーター書式を埋め込むことにより、SQLパラメーターの値をパラメーターまたは置換文字列として使用することができます。
SQLパラメーターはSQLビルダーを使って定義します。詳細については下記トピック「SQLビルダーの使い方」を参照してください。

ループ処理

ループを開始が「はい」の場合、このコンポーネントがループの起点となって結果セットのレコードを1レコードずつ出力します。

エラー処理

タイプパラメータエラー処理フローへのストリームエラー
コード
説明
汎用 なし コンポーネントの入力ストリーム例外コードSQL文が不正な場合
なし コネクション名に指定したコネクションが見つからない場合
例外コードSQL文がタイムアウトした場合
接続エラー なし コンポーネントの入力ストリーム なし Garoonとの接続に失敗した場合
レコードが無い なし コンポーネントの入力ストリーム3レコードが無い場合エラーが「はい」の場合で、レコードが0件の場合
4レコードが無い場合エラーが「はい」の場合で、フィルターを指定を適用した結果出力レコードが0件になった場合

フローの強制終了

フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。

SELECT文中のカラムと出力ストリームのフィールドの関係

SQLビルダーを終了後、「フィールド定義を更新しますか?」メッセージダイアログボックスが表示されます。「はい」をクリックすると、SQLビルダーで選択したSELECT文中のカラムがストリームペインで出力ストリームとして定義されます。「いいえ」をクリックすると、ストリームペインには定義されません。

本コンポーネントの出力ストリームとしてレコードを取得するには、ストリームペインにフィールドを定義する必要がありますが、SQLビルダーで生成したSELECT文中の各カラムと出力ストリームのフィールドは順序によってマッピングされるため、カラム名とフィールド名は一致する必要はありません。

SELECTされたカラム数が出力ストリームで定義されたフィールド数と異なる場合や、カラムのデータ型が対応するフィールドのデータ型と異なる場合でも、順序によってマッピングされます。

SQLビルダーの使い方

SQLビルダーは、SQL文を自動生成する専用ツールです。SQLビルダーを使うと、簡単な操作で以下のようなことができます。

●SQLビルダーを起動する

以下のいずれかの操作でSQLビルダーを起動します。

●SQLビルダーの画面

●読み込むテーブルを指定する

SQLビルダーを起動すると(1)にテーブルの一覧が表示されます。読み込むテーブルを指定するには、2つの方法があります。以下の方法で操作すると、(2)にテーブルのフィールド一覧が表示されます。

ドラッグ&ドロップ

(1)の一覧からテーブル名をクリックしてドラッグを開始し、(2)にドロップします。

メニューから

(2)の空いたスペースで右クリックして表示されるメニューから「テーブル名を指定して追加」をクリックします。表示されたダイアログでテーブル名を入力して「OK」をクリックします。

●Garoonの詳細情報を表示する

(1)または(2)に表示したテーブルをクリックすると、(3)に詳細情報が表示されます。

●実際に読み込むフィールドを指定する(SELECT)

実際に読み込むフィールドを指定するには、2つの方法があります。以下の方法で操作すると、(5)にSQL文が表示されます。

(2)の画面から

フィールドリストでフィールド名の左にあるチェックボックスをオンにします。(4)の選択列タブに表示されます。指定したフィールドを取り消すには、チェックボックスをオフにします。(4)の選択列タブから削除されます。

(4)の画面から(選択列タブ)

フィールド名の空いたフィールドをクリックして表示されるプルダウンリストから読み込むフィールドを選択します。

●読み込む指定をしたフィールドを編集する

(4)でフィールドをクリックしてから、右クリックして表示されるメニューから「上に移動」「下に移動」「削除」を操作します。

●重複を抑制する(DISTINCT)

(2)の画面で右クリックして表示されるメニューから「重複の抑制(DISTINCT)」を実行すると自動生成されるSELECT文にDISTINCT句が付加されます。

●レコードの並び替え(ORDER BY)

レコードを昇順または降順にソートして読み込むには、以下の2つの方法があります。以下の方法で操作すると、(5)のSQL文に反映されます。

(2)の画面から

フィールドリストでフィールドをクリックし、右クリックして表示されるメニューの「ソートに追加」から「昇順」または「降順」をクリックします。

(4)の画面から(ソートタブ)

フィールド名の空いたフィールドをクリックして表示されるプルダウンリストから並び替えのキーとなるフィールドを選択します。指定したフィールド名のソート順プルダウンリストから「昇順」または「降順」を選択します。

レコードの並び替えを取り消す

フィールドリストでフィールドをクリックし、右クリックして表示されるメニューの「ソートに追加」から「(なし)」をクリックします。
またはソートタブのフィールドをクリックし、右クリックして表示されるメニューから「削除」をクリックします。

●集計関数の使用(GROUP BY)

フィールドに対して集計関数を適用する場合には、以下の2つの方法があります。以下の方法で操作すると、(5)のSQL文に反映されます。

(2)の画面から

フィールドリストでフィールドをクリックし、右クリックして表示されるメニューから「集計関数」を経由して適用する集計関数を選択します。

(4)の画面から(集計関数タブ)

フィールド名の空いたフィールドをクリックして表示されるプルダウンリストから集計関数を適用するフィールドを選択します。指定したフィールド名の集計関数プルダウンリストから適用する集計関数を選択します。

「COUNT(*)」を設定する場合は「2」の画面からのみ設定でき、集計関数タブ上では選択できません。

集計関数を取り消す

(2)の画面でフィールドを選択しての右クリックメニューから「集計関数」を経由して「なし」を選択します。
または集計関数タブのフィールドをクリックし、右クリックして表示されるメニューから「削除」をクリックします。

集計関数が設定されていてもそのフィールドがSELECT対象に含まれていない(フィールドがチェックされていない)場合はSELECT句にその項目は含まれません。
GROUP BY句にはSELECT対象のフィールドで集計関数が含まれていないフィールドが自動的に設定されます。

●テーブルの結合(リレーション)

SQLビルダーでは、リレーションを含んだSQL文を自動生成することができます。テーブル間でリレーションを設定するには、以下の手順で行います。

  1. (2)に、複数の対象テーブルを表示します。
  2. 対象テーブルのフィールド名をクリックしてドラッグを開始し、他の対象テーブルのフィールド名へリンクを連結します。
  3. 連結したリンクを右クリックして表示されるメニューの「リレーション種別」から種別をクリックします。

リレーションを削除するには、連結したリンクを右クリックして表示されるメニューから「リレーション削除」をクリックします。

●レコードの抽出(WHERE)

SQLビルダーでは、レコードの抽出条件を固定値と比較したりフローの中での動的な値と比較したりする設定を行うことができます。また、条件式を直接入力してSQL文に追加記述することができます。

固定値と比較する

  1. (2)のフィールドリストでフィールドをクリックし、右クリックして表示されるメニューから「条件の追加」をクリックします。
  2. 条件の編集ダイアログボックスで「固定値との比較」ラジオボタンをクリックします。
  3. 条件式をプルダウンリストから選択します。
  4. 固定値をテキストフィールドに入力します。
  5. 値を「'」で囲む場合は、「値を「'」で囲む」チェックボックスをオンにします。

(5)のSQL文に抽出条件が追加されます。(2)のフィールドリストに条件式が表示されます。

SQLパラメーターを使って実行時の動的な値の抽出条件を指定する

SQLビルダーで、任意の名前のパラメーターを定義し、抽出条件にするフィールド名に条件を追加する際にパラメーター名を指定することにより、パラメーターをWHERE句をSQL文の中に組み込みます。本コンポーネントの前にマッパーを配置し、定義したパラメーターにマッピングすることにより、実行時の動的な値を抽出条件にすることができます。

動的な値の抽出条件を指定するためには、以下の手順で行います。

  1. 最初に、(4)のパラメータータブで、任意の名前、データ型、初期値のパラメーターを定義します。
  2. (2)のフィールドリストでフィールドをクリックし、右クリックして表示されるメニューから「条件の追加」をクリックします。
  3. 条件の編集ダイアログボックスで「パラメーターとの比較」ラジオボタンをクリックします。
  4. 条件式をプルダウンリストから選択します。
  5. 定義したパラメーターが表示されるプルダウンリストから選択します。
  6. 値を「'」で囲む場合は、「値を「'」で囲む」チェックボックスをオンにします。

GaroonGetコンポーネントの前にマッパーを配置し、マッピングウィンドウの出力側にあるパラメーターのフィールド名に値となるフィールドをマッピングします。

(5)のSQL文に抽出条件が追加されます。(2)のフィールドリストに条件式が表示されます。

任意の条件を指定する

任意の条件を指定するには、以下の2つの方法があります。以下の方法で操作すると、(5)のSQL文に抽出条件が追加されます。

条件の編集ダイアログボックスから

  1. (2)のフィールドリストでフィールドをクリックし、右クリックして表示されるメニューから「条件の追加」をクリックします。
  2. 条件の編集ダイアログボックスで「直接入力」ラジオボタンをクリックします。
  3. 条件式をテキストボックスに直接入力します。

(4)の画面から(条件タブ)

  1. 条件タブの「任意の条件を追加」をクリックします。
  2. 条件式をテキストボックスに直接入力します。

抽出条件を組み合わせる

いろいろな条件を組み合わせて抽出を行う場合、(4)の条件タブで論理演算子を指定することができます。条件フィールドの「関係」項目のプリダウンリストから「AND」または「OR」をクリックします。

抽出条件を編集する

指定した抽出条件を編集するには、条件タブのフィールドをダブルクリックします。または、フィールドをクリックし、右クリックして表示されるメニューから「条件の編集」をクリックします。

抽出条件を取り消す

条件タブのフィールドをクリックし、右クリックして表示されるメニューから「削除」をクリックします。

●SQLパラメーターを使って実行時に動的なSQL文を生成する

SQLビルダーのSQLパラメーターは、抽出条件(WHERE句)を設定する以外に、SQL文の中での任意の文字列を置き換えることができます。任意の名前のパラメーターを定義し、(5)で直接パラメーターを記述します。また、条件の編集ダイアログボックスで任意の条件を指定するときに記述することもできます。本コンポーネントの前にマッパーを配置し、定義したパラメーターにマッピングすることにより、実行時に動的なSQL文にすることができます。

動的なSQL文を指定するためには、以下の手順で行います。

  1. (4)のパラメータータブで、任意の名前、初期値で、データ型はStringのパラメーターを定義します。
  2. (5)で、置き換えたい文字列を使用する部分に「$パラメーターのフィールド名$」のようにフィールド名を$で囲んで記述します。
  3. GaroonGetコンポーネントの前にマッパーを配置します。
  4. マッピングウィンドウの出力側にあるSQLパラメーターのフィールド名に置換文字列となるフィールドをマッピングします。

●パラメーターを編集する

(4)でフィールドを右クリックして表示されるメニューから「上に移動」「下に移動」「挿入」「削除」を操作します。

●自動生成したSQL文を直接編集する

(1)~(4)の指定で自動生成したSQL文が(5)に表示されます。(5)を直接編集すると、そのSQL文をそのままGaroonに発行します。直接編集する際には、自動生成したSQL文と同期すると元に戻るため注意が必要です。同期設定については次項の「自動生成するSQL文表示のオプション」を参照してください。

●SQL文をテスト実行する

実際にGaroonにSQL文を発行してテスト実行するには、以下の手順で行います。

  1. (5)の画面下部右側にある「SELECTテスト」をクリックします。
  2. パラメーターを定義している場合、パラメーターの値を指定するダイアログボックスで「初期値」項目にテスト用の値を設定して「OK」をクリックします。

正常終了の場合、実行結果がダイアログボックスに結果セットが表示されます。異常終了の場合、エラーメッセージダイアログボックスに表示されます。

結果セットの表示数を変更する

(5)の画面下部右側にある「テスト結果の行数」フィールドの行数を変更してから「SELECTテスト」をクリックします。初期値は100です。

●自動生成するSQL文表示のオプション

(5)の表示については、画面下部右側でオプションを指定することができます。

(5)のSQL文の編集について

SQLビルダーを使って指定したフィールドの選択、条件などのことをモデルといいます。「SQLを常に同期する」チェックボックスがオンの場合、(1)~(4)のモデルと(5)のSQL文が同期して自動生成された状態です。自動生成したSQL文を(5)で直接編集することができます。この場合、モデルを操作すると直接編集したSQL文が同期しないように、自動的に「SQLを常に同期する」チェックボックスがオフになります。直接編集をリセットした場合や再度操作したモデルからSQL文を自動生成する場合、「モデルをSQLに適用する」をクリックします。

オプション

●注意事項

●Garoon コネクション設定

Auto Cache[AutoCache]

この接続プロパティがTrue に設定されている場合、本製品 はSELECT クエリの対象となるテーブルの内容を自動的にキャッシュします。これらのテーブルの内容は、CacheConnection およびCacheDriver 接続プロパティで指定されたキャッシュデータベースにキャッシュされます。

関連項目

  • CacheMetadataCacheMetadata を有効にすると、取得されたすべてのメタデータはキャッシュデータベースにミラーリングされます。これは、本製品 が以降にメタデータを検出しようとする場合に、メタデータがキャッシュデータベースから直接読み取られGaroon にメタデータをリクエストする時間が不要になるため、より高速になることを意味します。
  • 明示的なデータのキャッシュ:このセクションでは、AutoCacheOffline モードで使用する例を示します。
  • CACHE ステートメント:CACHE ステートメントを使用して、SELECT クエリの対象となる任意のテーブルの内容を明示的にキャッシュできます。


Default Value: false
Basic Auth Password[BasicAuthPassword]

Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。このフィールドは、BasicAuthUser とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

Basic Auth User[BasicAuthUser]

Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。このフィールドは、BasicAuthPassword とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

Batch Size[BatchSize]

このプロパティは、バッチ操作中に送信される各バッチのサイズを制御します。 0より大きい値に設定すると、本製品 は全体の操作を指定された行数を含む小さなバッチに分割します。 これらの小さなバッチは個別にサーバーに送信されます。

このプロパティは、サーバーがリクエストのサイズに制限を課している場合に役立ちます。 操作を小さな単位に分割することで、これらの制限を回避してバッチ処理を成功させることができます。


Default Value: 0
Browsable Schemas[BrowsableSchemas]

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Cache Connection[CacheConnection]

対象のキャッシュデータベースは、この接続プロパティとCacheDriver 接続プロパティの組み合わせによって決定されます。指定されたキャッシュデータベースを使用するには、両方のプロパティが必要です。

この接続プロパティで指定された接続文字列は、CacheDriver 接続プロパティで指定されたJDBC ドライバーに直接渡されます。使用可能な接続プロパティの詳細については、指定されたJDBC ドライバー のドキュメントを参照してください。

CacheDriver で指定したJDBC ドライバーがアプリケーションのクラスパスに含まれていることを確認してください。

以下に、一般的なキャッシュデータベースの設定例を示します。

Derby およびJava DB

CacheDriver とこの接続プロパティを使用して、Derby への接続を設定します。以下は、Derby JDBC URL 構文です。

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
例えば、インメモリデータベースにキャッシュするには、以下を使用します。
jdbc:derby:memory

SQLite

SQLite へキャッシュするにはSQLite JDBC ドライバーを使用できます。次はJDBC URL の構文です。

jdbc:sqlite:dataSource
  • Data Source:SQLite データベースファイルへのパス。または、:memoryの値を使ってインメモリにキャッシュします。

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL の例です。

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
一般的な接続プロパティは次のとおりです:

  • Server:キャッシュ先のMySQL データベースをホストしているサーバーのIP アドレスまたはドメイン名。
  • Port:指定されたサーバー上のMySQL インスタンスが実行されているポート。
  • Database:キャッシュ先のMySQL データベースの名前。指定されたサーバーでホストされているMySQL データベースの名前と一致する必要があります。
  • User:選択したMySQL データベースに登録されているユーザーのユーザー名。
  • Password:指定されたMySQL ユーザーに紐付けられたパスワード。

SQL Server

Microsoft JDBC Driver for SQL Server のJDBC URL の構文は次のとおりです。

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
次に例を示します。
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
次は一般的なSQL Server 接続プロパティです。
  • Server:SQL Server を起動しているコンピューターの名前またはネットワークアドレス名。デフォルトのインスタンスではなく、名前付きインスタンスに接続するには、ホスト名とインスタンス名をバックスラッシュで区切って指定します。
  • Port:指定されたサーバー上のSQL Server インスタンスが実行されているポート。
  • Database:キャッシュ先のSQL Server データベースの名前。指定されたサーバーでホストされているSQL Server データベースの名前と一致する必要があります。
  • Integrated Security:現在のWindows アカウントを認証に使用する場合は、このオプションをTrue に設定します。代わりにUser とPassword で認証するには、このオプションをFalse に設定します。

    統合セキュリティを使用するには、Windows システムパス上のフォルダにsqljdbc_auth.dll も追加する必要があります。このファイルは、Microsoft JDBC Driver for SQL Server インストールの"auth" サブフォルダにあります。アセンブリのビット数はJVM のビット数と一致する必要があります。

  • User Id:選択したSQL Server データベースに登録されているユーザーのユーザー名。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。
  • Password:指定されたSQL Server ユーザーに紐付けられたパスワード。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。

Oracle

次はOracle JDBC Thin ドライバーの従来のJDBC URL 構文です。

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
次に例を示します。
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
次は一般的な接続プロパティです。
  • Data Source:Oracle データベースを識別する接続記述子。これは、TSN 接続記述子、接続記述子を決定するOracle Net Services 名、またはバージョン11g 以降ではEasy Connect ネーミング(任意のポート名およびサービス名を持つOracle サーバーのホスト名)になります。

  • User Id:選択したOracle データベースに登録されているユーザーのユーザー名。
  • Password:指定されたOracle ユーザーにに紐付けられたパスワード。

PostgreSQL

次は公式のPostgreSQL JDBC ドライバーのJDBC URL 構文です。

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
例えば、次の接続文字列はデフォルトホスト(localhost)およびポート(5432)上のデータベースに接続します。
jdbc:postgresql:postgres
一般的な接続プロパティは次のとおりです:
  • Host:PostgreSQL データベースをホストしているサーバーのアドレス。
  • Port:指定されたホストサーバー上のPostgreSQL データベースがホストされているポート。
  • Database:キャッシュ先のPostgreSQL データベースの名前。指定されたサーバーでホストされているPostgreSQL データベースの名前と一致する必要があります。
  • User name:選択したPostgreSQL データベースに登録されているユーザーのユーザー名。"user" パラメータを使ってJDBC URL に指定できます。
  • Password:指定されたユーザーに紐付けられたパスワード。

Cache Driver[CacheDriver]

CData JDBC drivers を含むJDBC ドライバーが用意されている任意のデータベースにキャッシュできます。

Note:指定されたJDBC ドライバーのJAR ファイルをクラスパスに追加する必要があります。CData JDBC drivers の場合、このJAR ファイルはドライバーのインストールディレクトリの"lib" サブフォルダにあります。

また、CacheConnection 接続プロパティを設定して、指定されたJDBC ドライバーの接続文字列を入力する必要があります。

次の例は、いくつかの主要なデータベースにキャッシュする方法を示しています。JDBC URL 構文および一般的な接続プロパティの詳細については、CacheConnection を参照してください。

Derby およびJava DB

Java DB は、Derby のOracle ディストリビューションです。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

クラスパスにderbytools.jar を追加した後、以下のようにJava DB データベースにキャッシュすることができます。

jdbc:garoon:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;
インメモリデータベースにキャッシュするには、次のようにJDBC URL を使用します。
jdbc:garoon:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;

SQLite

次はSQLite JDBC ドライバーのJDBC URL です。

jdbc:garoon:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL です。

  jdbc:garoon:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;
  

SQL Server

次のJDBC URL はMicrosoft JDBC Driver for SQL Server を使用しています。

jdbc:garoon:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;

Oracle

次はOracle Thin Client のJDBC URL です。

jdbc:garoon:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;
NOTE:9i より前のバージョンのOracle を使用している場合は、キャッシュドライバーは代わりにoracle.jdbc.driver.OracleDriver になります。

PostgreSQL

次のJDBC URL は公式のPostgreSQL JDBC ドライバーを使用しています。

jdbc:garoon:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;

Cache Location[CacheLocation]

CacheLocation は単純なファイルベースキャッシュです。

本製品 はDerby データベースのOracle のディストリビューションあるJava DB をファイルベースのキャッシュに使用しています。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Garoon Data Provider となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます。

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Mac ~/Library/Application Support
Linux ~/.config

関連項目

  • AutoCache:後のオフライン使用のために、暗黙的にキャッシュを作成して維持するように設定します。
  • CacheMetadata:Garoon カタログをCacheLocation に永続化するように設定します。


Default Value: %APPDATA%\\CData\\Garoon Data Provider
Cache Metadata[CacheMetadata]

この接続プロパティがTrue に設定されている場合、クエリを実行すると、Garoon カタログのテーブルメタデータはCacheConnectionCacheDriver で指定されたキャッシュデータベースにキャッシュされ、もしこれらの接続プロパティが設定されていない場合はユーザーのホームディレクトリにキャッシュされます。

ホームディレクトリの場所はプラットフォームによって異なります。

プラットフォームホームディレクトリ
Windows %APPDATA%\\CData\\Garoon Data Provider
Mac ~/Library/Application Support/CData/Garoon Data Provider
Unix ~/.config/CData/Garoon Data Provider

テーブルのメタデータの取得は、テーブルがはじめてクエリされた際に一度だけ行われます。

CacheMetadata を使用するタイミング

本製品 がメタデータ検索で取得するGaroon テーブルとカラムの数が多い場合、本製品 がすべてのテーブルメタデータをリストするのに時間がかかることがあります。

次のような場合に、メタデータの取得に時間がかかることがあります。

  • 使用しているGaroon インスタンスのテーブル数が多い。
  • 本製品 が、接続プロパティによってデフォルト設定よりも多くのテーブルを検出するように設定されている。
  • 本製品 に対して多くの短期間接続を行っている。
CacheMetadata を有効にすると、取得されたすべてのメタデータはキャッシュデータベースにミラーリングされます。これは、本製品 が以降にメタデータを検出しようとする場合に、メタデータがキャッシュデータベースから直接読み取られGaroon にメタデータをリクエストする時間が不要になるため、より高速になることを意味します。

CacheMetadata を使用しないタイミング

本製品 は、はじめてテーブルやビューのメタデータを発見したときから最大1時間、そのメタデータをメモリに自動的に保持するため、通常はCacheMetadata は必要ありません。

CacheMetadata は、変動しやすいメタデータを扱うシナリオでは理想的ではありません。はじめてテーブルをクエリするとき、本製品 はそのメタデータをキャッシュデータベースファイルにキャッシュします。このキャッシュはテーブルスキーマの更新を反映するために動的に更新されることはないため、新規、変更、削除されたカラムを取得するには、キャッシュデータベースファイルを削除して再構築する必要があります。


Default Value: false
Cache Tolerance[CacheTolerance]

キャッシュ内のテーブルに対してクエリを実行すると、本製品 はキャッシュの最終更新から経過した時間を確認します。

キャッシュの最終更新がこの接続プロパティの値(秒単位)よりも前の場合、本製品 はキャッシュを更新します。

それ以外は、本製品 はキャッシュから直接データを返します。


Default Value: 600
Connection Life Time[ConnectionLifeTime]

このプロパティは、接続が本製品 によって自動的に閉じられるまでのアクティブな状態を維持する時間を制御します。 時間は秒単位で指定します。このプロパティを0より大きい値に設定すると接続の有効期間が制限され、その後本製品 が接続を終了します。

デフォルトではこのプロパティは0に設定されており、接続の有効期間に制限はありません。接続は明示的に閉じられるか、ネットワークの中断やセッションのタイムアウトなどの外部要因によって終了されるまで開いたままになります。

このプロパティは、リソースの利用状況を管理し、古くなった接続やアイドル状態の接続が無期限に持続するのを防ぐのに役立ちます。


Default Value: 0
Connect On Open[ConnectOnOpen]

true に設定すると、プロバイダーは「接続テスト」操作を実行します。これは、データベースツールで接続性を検証するために一般的に使用されます。 この操作はセッションデータを保持しません。単に接続が確立できるかどうかを確認するだけで、NOOP(操作なし)コマンドのように機能します。

false に設定すると、接続は操作が必要になるまで遅延されます。これは、接続が頻繁に開閉されるがすぐに操作が行われないようなシナリオでパフォーマンスが向上する場合があります。


Default Value: false
Firewall Password[FirewallPassword]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Firewall Port[FirewallPort]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。


Default Value: 0
Firewall Server[FirewallServer]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Firewall Type[FirewallType]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note:デフォルトでは、本製品 はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetectfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル デフォルトポート 説明
TUNNEL 80 本製品 がGaroon への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4 1080 本製品 がGaroon への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 本製品 がGaroon にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthSchemeProxyUser、およびProxyPassword を使ってください。


Default Value: NONE
Possible Values:
NONE0
TUNNEL1
SOCKS42
SOCKS53
Firewall User[FirewallUser]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Location[Location]

Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Garoon Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Mac ~/Library/Application Support
Linux ~/.config


Default Value: %APPDATA%\\CData\\Garoon Data Provider\\Schema
Logfile[Logfile]

このプロパティは、認証イベント、クエリ実行、接続の詳細など、本製品 の操作を記録するログファイルの場所と名前を指定します。 指定されたファイルが存在しない場合、本製品 はそのファイルを作成します。本製品 を実行しているユーザーまたはサービスが、指定されたパスまたはファイルへの書き込み権限を持っていることを確認してください。 適切な権限がない場合、ログファイルは作成されません。パスワードやトークンなどの接続文字列の機密情報は、ログで自動的にマスキングされます。 ただし、データ自体に含まれる機密情報はマスキングされない可能性があります。

Logfile に相対パスを指定し、Location プロパティが設定されている場合、そのディレクトリがログファイルのベースパスとして使用されます。

追加プロパティにより、ログの動作をカスタマイズできます。

  • ログファイルの詳細レベルを制御するには、Verbosity を使用します。
  • MaxLogFileSize でログファイルのサイズを管理し、MaxLogFileCount で保持するログファイルの数を制御します。
  • LogModules プロパティを調整することで、特定のログモジュールをフィルタリングします。

Java のログ出力

Java のログ出力もサポートされています。Java のログ出力を有効化するには、Logfile を次のように設定します:

Logfile=JAVALOG://myloggername

上記の例のように、JAVALOG:// がJava のログを使用するための必須プレフィックスで、独自のロガーで代用することになります。

次に、指定されたロガーのgetLogger メソッドが呼び出され、指定された値を使用してLogger インスタンスが作成されます。ログのインスタンスがすでに存在する場合は、既存のインスタンスを参照します。

Java のログ出力が有効になっている場合、Verbosity は特定のログレベルに対応します。

Log Modules[LogModules]

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

Max Log File Count[MaxLogFileCount]

各ログファイル名には、識別しやすいように日付と時刻が含まれています。

このプロパティには以下の値を指定できます。

  • 2以上の値を設定すると、保持されるログファイルの最大数が設定されます。
  • 値が1の場合、ログファイルは1つだけ保持されます。最大サイズに達すると、ファイルは削除され新しいファイルに置き換えられます。これにより、現在のログ以外の履歴は残りません。
  • 0または負の値を設定すると、ログファイルの数に制限がなくなりログ記録が無期限に続きます。

ログファイルのサイズを管理するには、MaxLogFileSize プロパティを使用します。これらの2つのプロパティは、ログフォルダ内のログファイルのサイズと保持を制御するために連携して動作します。


Default Value: -1
Max Log File Size[MaxLogFileSize]

100 KB より小さい値の場合、本製品 は100 KB を最小許容サイズとして使用します。

保持されるログファイルの総数を制御するには、このプロパティとMaxLogFileCount プロパティを組み合わせて使用します。 これらのプロパティを組み合わせることで、ログファイルのサイズと保持を効果的に管理できます。


Default Value: 100MB
Max Rows[MaxRows]

このプロパティは、集計やGROUP BY 句を含まないクエリに対して本製品 が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。


Default Value: -1
Offline[Offline]

この接続プロパティががTrue に設定されている場合、すべてのクエリは、ライブGaroon データではなくキャッシュデータベースに対して実行されます。

このモードでは、INSERT、UPDATE、DELETE、CACHE などの一部のSQL 操作が無効になります。


Default Value: false
Other[Other]

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

キャッシュの設定

CachePartial=Trueクエリで指定可能な一部のカラムのみをキャッシュします。
QueryPassthrough=True本製品 のSQL パーサーを使用する代わりに、指定のクエリをキャッシュデータベースに渡します。

統合およびフォーマット

DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

Pagesize[Pagesize]

クエリを処理する際、Garoon でクエリされたデータすべてを一度にリクエストする代わりに、本製品 はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、本製品 がページごとにリクエストする結果の最大数を決定します。

大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時に本製品 がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあることに注意してください。


Default Value: 1000
パスワード[Password]

認証サーバーは、ユーザーのID を検証するためにUserPassword の両方を必要とします。

Pool Idle Timeout[PoolIdleTimeout]

このプロパティは、UseConnectionPooling が有効な場合にのみ適用されます。接続プーリングは、リクエストごとに新しい接続を作成するのではなく、確立されたデータベース接続を再利用するメカニズムです。 これにより、頻繁な接続作成に伴うオーバーヘッドを削減し、パフォーマンスが向上します。

PoolIdleTimeout は、使用されていない接続を閉じてリソースを管理するのに役立ち、アイドル接続を維持することによる潜在的なオーバーヘッドを削減します。 値を小さくするとアイドル状態の接続を迅速にクリーンアップできます。一方、値を大きくすると接続を長く開いておけるため、再接続が頻繁に発生するシナリオではパフォーマンスが向上する可能性があります。


Default Value: 60
Pool Max Size[PoolMaxSize]

このプロパティは、接続プールで維持できるアクティブな接続の最大数を定義します。 このプロパティは、UseConnectionPooling がtrue に設定されている場合にのみ適用されます。 上限に達すると、新しい接続リクエストは既存の接続がプールに戻されるのを待つ必要があります。

プロパティを0または負の値に設定して接続プールを無効にすると接続の管理を簡素化できますが、トラフィックが多いシナリオではパフォーマンスが低下する可能性があります。 このプロパティは、リソースの使用率を最適化し、アプリケーションがサーバーやネットワークの制限を超えないようにするのに役立ちます。


Default Value: 100
Pool Min Size[PoolMinSize]

このプロパティは、指定された最小数の接続が常に接続プールで利用可能であることを確実にします。 この設定は、接続を事前に初期化してすぐに使用できる状態に保つことで、待ち時間を減らすのに役立ちます。

デフォルトでは、プロバイダーはプールに少なくとも1つの接続を維持します。 より大きな値を設定することで、一貫したトラフィックがある環境でのパフォーマンスを向上させることができますが、リソースの使用量が増加する可能性があります。 値を小さくすると、非アクティブ時にプールがすべての接続を解放し、リソースの消費を抑えることができます。


Default Value: 1
Pool Wait Time[PoolWaitTime]

このプロパティは、新しい接続リクエストがプールの利用可能な接続を待機する時間を制御します。 指定された時間内に接続が利用可能にならない場合、本製品 はエラーを返します。

デフォルト値は60秒で、接続リクエストが無期限に待機しないようにします。 トラフィックが多い環境やプールサイズが限られている場合、この値を大きくすることで接続が利用可能になるまでの時間を延ばすことができますが、失敗したリクエストのエラー処理が遅れる可能性があります。


Default Value: 60
Proxy Auth Scheme[ProxyAuthScheme]

認証タイプは次のいずれかです。

  • BASIC:本製品 はHTTP BASIC 認証を行います。
  • DIGEST:本製品 はHTTP DIGEST 認証を行います。
  • NTLM:本製品 はNTLM トークンを取得します。
  • NEGOTIATE:本製品 は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • NONE:ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。


Default Value: BASIC
Possible Values:
BASIC0
DIGEST1
NONE2
NEGOTIATE3
NTLM4
Proxy Auto Detect[ProxyAutoDetect]

この接続プロパティをTrue に設定すると、本製品 は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するために本製品 を構成する場合は、ProxyAutoDetectFalse に設定します。

このプロパティがTrue に設定されている場合、使用するプロキシはこれらの場所をこの順番でチェックして決定されます。ある場所でプロキシが決定できない場合、本製品 は次の場所をチェックします。

  1. 本製品 は、JVM のプロパティ(http.proxy、https.proxy、socksProxy など)から検索を行います。
  2. JVM のプロパティが存在しない場合、本製品 はjava.home/lib/net.properties を検索します。
  3. java.net.useSystemProxies がTrue に設定されている場合、本製品 はSystemProxy を検索します。
  4. Windows では、本製品はレジストリインターネットオプション、具体的にはレジストリキーHKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\ からプロキシ設定を読み取ります。Windows 10以降では、Windows の設定にあるプロキシの設定に対応します。

これらの設定は、マシンの現在のユーザーにのみ適用されることに注意してください。アプリケーションをサービスとして実行している場合、本製品 はユーザー設定を読み込みません。代わりに、本製品 の接続プロパティでプロキシ設定を手動で行う必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。


Default Value: false
Proxy Exceptions[ProxyExceptions]

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note:本製品 はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetectFalse に設定します。

Proxy Password[ProxyPassword]

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyPassword に設定する値
BASIC ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

本製品 は、ProxyAutoDetectFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

Proxy Port[ProxyPort]

ProxyAutoDetectFalse に設定されている場合、本製品 はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。


Default Value: 80
Proxy Server[ProxyServer]

ProxyAutoDetectFalse に設定されている場合、本製品 はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

Proxy SSL Type[ProxySSLType]

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTOデフォルト設定。ProxyServer がHTTPS URL に設定されている場合、本製品 は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。


Default Value: AUTO
Possible Values:
AUTO0
ALWAYS1
NEVER2
TUNNEL3
Proxy User[ProxyUser]

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyUser に設定する値
BASIC プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE ProxyPassword 接続プロパティは設定しないでください。

本製品 は、ProxyAutoDetectFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

Pseudo Columns[PseudoColumns]

このプロパティを使用すると、本製品 がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

Readonly[Readonly]

true に設定すると、本製品 はSELECT クエリのみを許可します。INSERT、UPDATE、DELETE、またはストアドプロシージャのクエリを実行しようとすると、失敗してエラーメッセージが表示されます。


Default Value: false
RTK[RTK]

ほとんどの構成で標準的なライセンス機構をサポートしているため、通常はこのプロパティは不要です。 このプロパティの設定方法については、同梱のライセンスドキュメントを参照してください。このランタイムキーは、OEM ライセンスを購入した場合にのみ使用できます。

Warning: このプロパティの値は既存のすべてのライセンス情報よりも優先されます。ライセンスエラーを避けるため、提供されたランタイムキーが正しいことを確認してください。

SSL Client Cert[SSLClientCert]

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY(個人証明書)などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL Client Cert Password[SSLClientCertPassword]

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

SSL Client Cert Subject[SSLClientCertSubject]

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。本製品 は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、本製品 はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

Note: フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例:CN="Example, Inc.", C=US。


Default Value: *
SSL Client Cert Type[SSLClientCertType]

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルトWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。


Default Value: USER
Possible Values:
USER0
MACHINE1
PFXFILE2
PFXBLOB3
JKSFILE4
JKSBLOB5
PEMKEY_FILE6
PEMKEY_BLOB7
PUBLIC_KEY_FILE8
PUBLIC_KEY_BLOB9
SSHPUBLIC_KEY_FILE10
SSHPUBLIC_KEY_BLOB11
P7BFILE12
PPKFILE13
XMLFILE14
XMLBLOB15
BCFKSFILE16
BCFKSBLOB17
SSL Server Cert[SSLServerCert]

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

証明書は、システムのトラストストアに基づいてマシンによって信頼されていると検証されています。使用されるトラストストアは、システムに指定された'javax.net.ssl.trustStore' 値になります。このプロパティに値が指定されていない場合は、Java のデフォルトのトラストストア(例えば、JAVA_HOME\lib\security\cacerts)が使用されます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Tables[Tables]

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

タイムアウト(秒)[Timeout]

このプロパティは、本製品 が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、本製品 は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリはタイムアウトの値を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。


Default Value: 60
URL[URL]

'https://cyp344.cybozu.com' 形式のGaroon アカウントのURL。

Use Connection Pooling[UseConnectionPooling]

このプロパティは、頻繁な接続作成に関連するオーバーヘッドを削減し、接続の使用率が高いアプリケーションのパフォーマンスを向上させます。 接続プーリングが有効な場合、アプリケーションは各接続が不要になったら明示的に閉じる必要があります。 接続を閉じると、物理的に終了するのではなく、再利用できるようにプールに戻ります。 接続がPoolIdleTimeout 時間を超えてアイドル状態になると、本製品 は自動的に接続を閉じてリソースを解放します。

デフォルトでは、接続プーリングは無効になっています。追加のプロパティ(PoolMaxSizePoolIdleTimeoutPoolWaitTime など)を使用すると、接続プールの動作をカスタマイズできます。 これらの設定は、プールサイズ、アイドル接続タイムアウト、および接続が利用可能になるまでの待機時間の細かい調整を可能にします。 接続プールの使用に関する詳細は、接続プール を参照してください。


Default Value: false
ユーザー[User]

認証サーバーは、ユーザーのID を検証するためにUserPassword の両方を必要とします。

User Defined Views[UserDefinedViews]

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューは本製品 によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。


{
	"MyView": {
		"query": "SELECT * FROM Events WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみが本製品 によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

Verbosity[Verbosity]

このプロパティは、本製品 がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。


Default Value: 1
Views[Views]

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。