DB2Connection インターフェース

com.ibm.db2.jcc.DB2Connection インターフェースは、 java.sql.Connection インターフェースを拡張します。

DB2Connection は java.sql.Wrapper インターフェースをインプリメントします。

DB2Connection のメソッド

以下のメソッドは、 IBM® Data Server Driver for JDBC and SQLJに対してのみ定義されます。

alternateWasUsedOnConnect

フォーマット：

public boolean alternateWasUsedOnConnect()
  throws java.sql.SQLException

接続を取得するためにドライバーが代替サーバー情報を使用した場合は、true を戻します。代替サーバー情報は、データベース・サーバーが 1 次サーバーと代替サーバーの変更時に更新する、DB2BaseDataSource 上の一時 clientRerouteServerList 情報から入手可能です。

changeDB2Password

フォーマット：

public abstract void changeDB2Password(String oldPassword, 
  String newPassword) 
  throws java.sql.SQLException

Connection オブジェクトのユーザー用の、データ・ソースへのアクセス用のパスワードを変更します。

パラメーターの説明:

oldPassword: Connection のオリジナル・パスワード。
newPassword: Connection の新規パスワード。

createArrayOf

フォーマット：

Array createArrayOf(String typeName,
  Object[] elements)
  throws SQLException;

java.sql.Array オブジェクトを作成します。

パラメーターの説明:

typeName: 配列のエレメントがマップする SQL データ・タイプ。 typeName は組み込みデータ・タイプまたは特殊タイプにすることができます。
elements: Array オブジェクトを取り込むエレメント。

createStruct

フォーマット：

Struct createStruct(String typeName,
  Object[] attributes)
  throws SQLException;

typeName にマップされ、 attributesで指定された属性を持つ java.sql.Struct オブジェクトを返します。

パラメーターの説明:

typeName: Struct オブジェクトのマップ先となる SQL 構造化タイプの SQL データ・タイプ。 typeName は、データ・サーバー上で定義されているユーザー定義タイプの名前です。
attributes: 戻された Struct オブジェクトに設定する属性。

deregisterDB2XmlObject

形式:

public void deregisterDB2XmlObject(String sqlIdSchema,
  String sqlIdName)
  throws SQLException

データ・ソースから、事前に登録された XML スキーマを除去します。

パラメーターの説明:

sqlIdSchema: XML スキーマの SQL スキーマ名。 sqlIdSchema は最大長が 128 バイトの String 値です。 sqlIdSchema の値は、SQL スキーマ名の命名規則に準拠している必要があります。名前の先頭をストリング 'SYS' にすることはできません。 sqlIdSchema の値が NULL の場合、データベース・システムは CURRENT SCHEMA 特殊レジスター内の値を使用します。
sqlIdName: XML スキーマの SQL 名。 sqlIdName は最大長が 128 バイトの String 値です。 sqlIdName の値は、SQL ID の規則に従っていなければなりません。 sqlIdSchema の値が NULL の場合、sqlIdName の値は NULL にすることができます。この場合、データベース・システムは sqlIdName の値を生成します。

getDB2ClientAccountingInformation

フォーマット：

public String getDB2ClientAccountingInformation()
  throws SQLException

現在のクライアントのアカウンティング情報を戻します。

重要: getDB2ClientAccountingInformation は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.getClientInfo を使用してください。

getDB2ClientApplicationInformation

フォーマット：

public String getDB2ClientApplicationInformation()
  throws java.sql.SQLException

現在のクライアントのアプリケーション情報を戻します。

重要: getDB2ClientApplicationInformation は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.getClientInfo を使用してください。

getDB2ClientCorrelationToken

フォーマット：

public String getDB2ClientCorrelationToken()
  throws SQLException

現在のクライアントのクライアント相関トークンを返します。

getDB2ClientCorrelationToken は、 Db2® for z/OS®への接続にのみ適用されます。

重要: getDB2ClientCorrelationToken は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.getClientInfo を使用してください。

getDB2ClientProgramId

フォーマット：

public String getDB2ClientProgramId()
  throws java.sql.SQLException

クライアントのユーザー定義プログラム ID を戻します。プログラム ID は、データ・ソースでアプリケーションを識別するために使用できます。

getDB2ClientProgramId は、 Linux®、UNIX、および Windows システム上の Db2 データ・サーバーには適用されません。

getDB2ClientUser

フォーマット：

public String getDB2ClientUser()
  throws java.sql.SQLException

接続のための現在のクライアントのユーザー名を戻します。この名前は、JDBC 接続のユーザー値ではありません。

重要: getDB2ClientUser は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.getClientInfo を使用してください。

getDB2ClientWorkstation

フォーマット：

public String getDB2ClientWorkstation()
  throws java.sql.SQLException

現在のクライアントの現在のクライアント・ワークステーション名を戻します。

重要: getDB2ClientWorkstation は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.getClientInfo を使用してください。

getDB2Correlator

フォーマット：

String getDB2Correlator() 
  throws java.sql.SQLException

DRDA が ACCRDB コマンドで送信する crrtkn (相関トークン) インスタンス変数の値を戻します。相関トークンは、サーバーへの論理接続を一意的に識別します。

getDB2CurrentPackagePath

フォーマット：

public String getDB2CurrentPackagePath()
  throws java.sql.SQLException

JDBC および SQLJ パッケージが検索される Db2 パッケージ・コレクションのリストを戻します。

getDb2CurrentPackagePath メソッドは、Db2 データベース・システムへの接続にのみ適用されます。

getDB2CurrentPackageSet

フォーマット：

public String getDB2CurrentPackageSet()
  throws java.sql.SQLException

接続のためのコレクション ID を戻します。

getDb2CurrentPackageSet メソッドは、Db2 データベース・システムへの接続にのみ適用されます。

getDB2ProgressiveStreaming

フォーマット：

public int getDB2ProgressiveStreaming()
  throws java.sql.SQLException

接続に関する現在の連続ストリーミング設定を戻します。

戻り値は、データ・ソースで連続ストリーミングがサポートされるかどうか、progressiveStreaming プロパティーがどのように設定されているか、および DB2Connection.setProgressiveStreaming が呼び出されたかどうかに応じて異なります。

データ・ソースで連続ストリーミングがサポートされない場合、progressiveStreaming プロパティーの設定値とは無関係に常に 2 (NO) が戻されます。
データ・ソースで連続ストリーミングがサポートされ、DB2Connection.setProgressiveStreaming が呼び出された場合には、DB2Connection.setProgressiveStreaming で設定された値が戻り値になります。
データ・ソースで連続ストリーミングがサポートされるものの、DB2Connection.setProgressiveStreaming が呼び出されなかった場合には、progressiveStreaming の設定値が DB2BaseDataSource.NOであれば戻り値は 2 (NO) です。 progressiveStreaming の設定値が DB2BaseDataSource.YES であるか、設定されていない場合には、戻り値は 1 (YES) です。

getDB2SecurityMechanism

フォーマット：

public int getDB2SecurityMechanism()
  throws java.sql.SQLException

接続に有効なセキュリティー・メカニズムを戻します。

3: 平文パスワード・セキュリティー
4: ユーザー ID のみのセキュリティー
7: パスワード暗号化セキュリティー
9: ユーザー ID とパスワードの暗号化セキュリティー
11: Kerberos セキュリティー
12: ユーザー ID とデータの暗号化セキュリティー
13: ユーザー ID、パスワード、およびデータの暗号化セキュリティー
15: プラグイン・セキュリティー
16: ユーザー ID のみの暗号化セキュリティー

getDB2SystemMonitor

フォーマット：

public abstract DB2SystemMonitor getDB2SystemMonitor()
  throws java.sql.SQLException

接続のシステム・モニター・オブジェクトを戻します。各 IBM Data Server Driver for JDBC and SQLJ 接続は、単一のシステム・モニターを持つことができます。

getDBConcurrentAccessResolution

フォーマット：

public int getDBConcurrentAccessResolution()
  throws java.sql.SQLException

接続に関する並行アクセス設定を戻します。並行アクセス設定は setDBConcurrentAccessResolution メソッドまたは concurrentAccessResolution プロパティーによって設定されます。

getDBConcurrentAccessResolution は、 Db2 for z/OS および Linux、UNIX、および Windows システム上の Db2への接続にのみ適用されます。

getDBProgressiveStreaming

フォーマット：

public int getDB2ProgressiveStreaming()
  throws java.sql.SQLException

接続に関する現在の連続ストリーミング設定を戻します。

データ・ソースで連続ストリーミングがサポートされない場合、progressiveStreaming プロパティーの設定値とは無関係に常に 2 (NO) が戻されます。
データ・ソースで連続ストリーミングがサポートされ、DB2Connection.setProgressiveStreaming が呼び出された場合には、DB2Connection.setProgressiveStreaming で設定された値が戻り値になります。
データ・ソースで連続ストリーミングがサポートされるものの、DB2Connection.setProgressiveStreaming が呼び出されなかった場合には、progressiveStreaming の設定値が DB2BaseDataSource.NOであれば戻り値は 2 (NO) です。 progressiveStreaming の設定値が DB2BaseDataSource.YES であるか、設定されていない場合には、戻り値は 1 (YES) です。

getDBStatementConcentrator

フォーマット：

public int getDBStatementConcentrator()
  throws java.sql.SQLException

接続に関するステートメント・コンセントレーター使用の設定を戻します。ステートメント・コンセントレーター使用の設定は setDBStatementConcentrator メソッドまたは statementConcentrator プロパティーによって設定されます。

getJccLogWriter

フォーマット：

public PrintWriter getJccLogWriter()
  throws java.sql.SQLException

IBM Data Server Driver for JDBC and SQLJ トレースの現在のトレース宛先を戻します。

getJccSpecialRegisterProperties

フォーマット：

public java.util.Properties getJccSpecialRegisterProperties()
  throws java.sql.SQLException

java.util.Properties オブジェクトを戻します。その中で、キーは、ターゲット・データ・ソースでサポートされる特殊レジスターで、キー値は、それらの特殊レジスターの現行値です。

この方法は、 IBM Informix® データ・ソースへの接続には適用されません。

getSavePointUniqueOption

フォーマット：

public boolean getSavePointUniqueOption()
  throws java.sql.SQLException

ReturnstruesetSavePointUniqueOption が最後に呼び出されたときの値:true. 戻りfalse最初の 2 つ以外の場合です。

installDB2JavaStoredProcedure

フォーマット：

public void DB2Connection.installDB2JavaStoredProcedure(
  java.io.InputStream jarFile,
  int jarFileLength,
  String jarId) 
  throws java.sql.SQLException

Linux、UNIX、および Windows システム上の Db2 サーバー上の sqlj.install_jar ストアード・プロシージャーを呼び出して、そのサーバーのカタログに JAR ファイルの新しい定義を作成します。

パラメーターの説明:

jarFile: サーバーに定義される JAR ファイルの内容。
jarFileLength: サーバーに定義される JAR ファイルの長さ。
jarId: データベース内の JAR の名前。schema.JAR-id または JAR-id の形式になります。これは、SQL ステートメントで JAR を参照する場合に使用する名前です。 schemaを省略すると、データベース・システムは CURRENT SCHEMA 特殊レジスター内にある SQL 許可 ID を使用します。 JAR の所有者は、CURRENT SQLID 特殊レジスター内の許可 ID です。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

isDB2Alive

フォーマット：

public boolean DB2Connection.isDB2Alive()
  throws java.sql.SQLException

Returnstrueデータ・ソースへの接続用のソケットがまだアクティブである場合。

重要: isDB2Alive は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、Connection.isDBValid を使用してください。

isDBValid

フォーマット：

public boolean DB2Connection.isDBValid(boolean throwException, int timeout)
  throws java.sql.SQLException

Returnstrue接続がクローズされておらず、まだ有効である場合。 Returnsfalse最初の 2 つ以外の場合です。

パラメーターの説明:

throwException

接続が無効な場合に isDBValid によって SQLException がスローされるかどうかを指定します。可能な値は以下のとおりです。

true: 接続が無効な場合、isDBValid は SQLException をスローします。
false: isDBValid が SQLException をスローするのは、 timeout の値が無効な場合のみです。

timeout

ドライバーがサブミットしたデータベース操作の完了を待機する時間 (秒)。ドライバーは、接続を妥当性検査するために、データ・ソースに対してそのデータベース操作をサブミットします。データベース操作が完了する前にタイムアウト期間が満了した場合、 isDBValid は以下を返します。false. 値 0 は、データベース操作のタイムアウト期間がないことを示します。

IBM Data Server Driver for JDBC and SQLJ タイプ 4 接続では、 timeout の値が 0 より小さい場合、 isDBValid は SQLException をスローします。

IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続では、 timeout の値が 0 でない場合、 isDBValid は SQLException をスローします。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

prepareDB2OptimisticLockingQuery

フォーマット：

public java.sql.PreparedStatement 
  DB2Connection.prepareDB2OptimisticLockingQuery(String sql, 
  int returnOptimisticLockingColumns)
  throws SQLException

オプティミスティック・ロック情報を要求できる PreparedStatement オブジェクトを作成します。

パラメーターの説明:

sql

準備される SQL ステートメント。

returnOptimisticLockingColumns

オプティミスティック・ロック列を戻すかどうかを指定します。可能な値は以下のとおりです。

表 1. returnOptimisticLockingColumns パラメーターの値
値	説明
DB2Statement.RETURN_OPTLOCK_COLUMN_NONE (0)	オプティミスティック・ロック列を戻しません。
DB2Statement.RETURN_OPTLOCK_COLUMN_ALWAYS (1)	行の変更列が単一の行を一意的に表さない場合でも、行の変更列を結果セットに追加します。この設定は、データベース準備属性 WITH ROW CHANGE COLUMNS POSSIBLY DISTINCT に相当します。
DB2Statement.RETURN_OPTLOCK_COLUMN_NO_FALSE_NEGATIVES (2)	行の変更列が単一の行を一意的に表す場合にのみ、その行の変更列を結果セットに追加します。この設定は、データベース準備属性 WITH ROW CHANGE COLUMNS ALWAYS DISTINCT に相当します。

reconfigureDB2Connection

フォーマット：

public void reconfigureDB2Connection(java.util.Properties properties)
  throws SQLException

接続を新規設定で再構成します。接続は、再構成前に接続プールに戻す必要はありません。このメソッドは、トランザクションの進行中に呼び出して、トラステッドまたは非トラステッド接続に使用することができます。

トラステッド接続は、以下の場合にサポートされます。

IBM Data Server Driver for JDBC and SQLJ タイプ 4 接続 :
- Linux、UNIX、および Windows システム上のDb2 バージョン 9.5 以降
- Db2 for z/OS バージョン 9.1 以降
- IBM Informix バージョン 11.70 以降
Db2 for z/OS バージョン 9.1 以降の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続

パラメーターの説明:

properties: 接続の新規プロパティー。これらのプロパティーは、DB2Connection インスタンスですでに定義されているプロパティーをオーバーライドします。

registerDB2XmlSchema

形式:

public void registerDB2XmlSchema(String[] sqlIdSchema,
  String[] sqlIdName,
  String[] xmlSchemaLocations,
  InputStream[] xmlSchemaDocuments,
  int[] xmlSchemaDocumentsLengths,
  InputStream[] xmlSchemaDocumentsProperties,
  int[] xmlSchemaDocumentsPropertiesLengths,
  InputStream xmlSchemaProperties,
  int xmlSchemaPropertiesLength,
  boolean isUsedForShredding)
  throws SQLException
public void registerDB2XmlSchema(String[] sqlIdSchema,
  String[] sqlIdName,
  String[] xmlSchemaLocations,
  String[] xmlSchemaDocuments,
  String[] xmlSchemaDocumentsProperties,
  String xmlSchemaProperties,
  boolean isUsedForShredding)
  throws SQLException

XML スキーマを 1 つ以上の XML スキーマ文書に登録します。複数の XML スキーマ文書が registerDB2XmlSchema への 1 呼び出しで処理される場合、これらの文書は単一トランザクションの一部として処理されます。

registerDB2XmlSchema の最初のフォームは、入力ストリームから読み取られる XML スキーマ文書です。 registerDB2XmlSchema の 2 番目のフォームは、ストリングから読み取られる XML スキーマ文書です。

パラメーターの説明:

sqlIdSchema: XML スキーマの SQL スキーマ名。 sqlIdSchema 配列の最初のエレメントだけが使用されます。 sqlIdSchema は最大長が 128 バイトの String 値です。 sqlIdSchema の値は、SQL スキーマ名の命名規則に準拠している必要があります。名前の先頭をストリング 'SYS' にすることはできません。 sqlIdSchema の値が NULL の場合、データベース・システムは CURRENT SCHEMA 特殊レジスター内の値を使用します。
sqlIdName: XML スキーマの SQL 名。 sqlIdName 配列の最初のエレメントだけが使用されます。 sqlIdName は最大長が 128 バイトの String 値です。 sqlIdName の値は、SQL ID の規則に従っていなければなりません。 sqlIdSchema の値が NULL の場合、sqlIdName の値は NULL にすることができます。この場合、データベース・システムは sqlIdName の値を生成します。
xmlSchemaLocations: 登録されるスキーマの 1 次 XML スキーマ文書の、XML スキーマ・ロケーション。 XML スキーマ・ロケーションの値は、通常は URI 形式です。各 xmlSchemaLocations 値は、最大長が 1000 バイトの String 値です。この値は、この文書を参照する XML スキーマ文書内で指定された情報と突き合わせるためだけに使用されます。データベース・システムは、フォーマットの検査は実行せず、URI の解決を試行することもありません。
xmlSchemaDocuments: 1 次 XML スキーマ文書の内容。各 xmlSchemaDocuments 値は、最大長が 30MB の String または InputStream 値です。値は NULL であってはなりません。
xmlSchemaDocumentsLengths: xmlSchemaDocuments パラメーター内の XML スキーマ文書の長さ ( registerDB2XmlSchema の最初の形式を使用する場合)。各 xmlSchemaDocumentsLengths 値は int 値です。
xmlSchemaDocumentsProperties: 1 次 XML スキーマ文書のプロパティーが含まれます。これは、外部 XML スキーマ・バージョン管理システムで使用されるプロパティーなどです。データベース・システムは、これらの値の内容の妥当性検査は行いません。これらの値は検索のために XSR 表に保管され、他のツールまたは XML スキーマ・リポジトリーのインプリメンテーションで使用されます。各 xmlSchemaDocumentsProperties 値は、最大長が 5MB の String または InputStream 値です。渡されるプロパティーがない場合、値は NULL です。
xmlSchemaDocumentsPropertiesLengths: xmlSchemaDocumentsProperties パラメーターの XML スキーマ・プロパティーの長さ (最初の形式の registerDB2XmlSchema を使用する場合)。各 xmlSchemaDocumentsPropertiesLengths 値は int 値です。
xmlSchemaProperties: XML スキーマ全体のプロパティーが含まれます。これは、外部 XML スキーマ・バージョン管理システムで使用されるプロパティーなどです。データベース・システムは、この値の内容の妥当性検査は行いません。これらの値は検索のために XSR 表に保管され、他のツールまたは XML スキーマ・リポジトリーのインプリメンテーションで使用されます。 xmlSchemaProperties 値は、最大長が 5MB の String または InputStream 値です。渡されるプロパティーがない場合、値は NULL です。
xmlSchemaPropertiesLengths: xmlSchemaProperties パラメーター内の XML スキーマ・プロパティーの長さ ( registerDB2XmlSchema の最初の形式を使用する場合)。 xmlSchemaPropertiesLengths 値は int 値です。
isUsedForShredding: XML 分解に使用されるアノテーションがスキーマ内にあるかどうかを示します。 isUsedForShredding はブール値です。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

setDBConcurrentAccessResolution

フォーマット：

public void setDBConcurrentAccessResolution(int concurrentAccessResolution)
  throws java.sql.SQLException

データ・ソースが現在コミットされているデータへのアクセスをサポートしており、アプリケーション分離レベルがカーソル固定 (CS) または読み取り固定 (RS) である場合に、 IBM Data Server Driver for JDBC and SQLJ が、書き込みトランザクションによって非互換でロックされている行のコミット済みの整合したイメージに読み取りトランザクションがアクセスできるように要求するかどうかを指定します。このオプションは Db2 CONCURRENTACCESSRESOLUTION バインド・オプションと同じ効果を及ぼします。 setDBConcurrentAccessResolution は、setDBConcurrentAccessResolution の実行後に作成されたステートメントにのみ影響を与えます。

setDBConcurrentAccessResolution は、 Db2 for z/OS および Linux、UNIX、および Windows システム上の Db2への接続にのみ適用されます。

パラメーターの説明:

concurrentAccessResolution

以下のいずれかの整数値になります。

DB2BaseDataSource.-

CONCURRENTACCESS_USE_CURRENTLY_COMMITTED (1)

IBM Data Server Driver for JDBC and SQLJ は、以下のことを要求します。

データの更新時または削除時に、読み取りトランザクションは currently committed データにアクセスする。
読み取りトランザクションは、挿入されようとしている行をスキップする。

DB2BaseDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME (2)

IBM Data Server Driver for JDBC and SQLJ は、以下のことを要求します。

更新または削除されようとしているデータが検出された場合、読み取りトランザクションはコミットまたはロールバック操作を待機する。
読み取りトランザクションは、挿入されようとしている行をスキップしない。

DB2BaseDataSource.CONCURRENTACCESS_NOT_SET (0)

ロック競合が発生した場合の読み取りトランザクションに関するデータ・サーバーのデフォルト動作を使用可能にします。これはデフォルト値です。

setDBProgressiveStreaming

フォーマット：

public void setDB2ProgressiveStreaming(int newSetting)
  throws java.sql.SQLException

接続で作成されるすべての ResultSet オブジェクトに関する連続ストリーミングを設定します。

パラメーターの説明:

newSetting

新しい連続ストリーミング設定。可能な値は以下のとおりです。

DB2BaseDataSource.YES (1): 連続ストリーミングを有効にします。データ・ソースで連続ストリーミングがサポートされない場合、これを設定しても効果はありません。
DB2BaseDataSource.NO (2): 連続ストリーミングを無効にします。

setDBStatementConcentrator

フォーマット：

public void setDBStatementConcentrator(int statementConcentratorUse)
  throws java.sql.SQLException

IBM Data Server Driver for JDBC and SQLJ がデータ・ソースのステートメント・コンセントレーター機能を使用するかどうかを指定します。ステートメント・コンセントレーターは、(リテラル値を除いて) 動的ステートメント・キャッシュ内のステートメントと同じである場合にステートメントの準備を迂回する機能です。ステートメント・コンセントレーター機能は、リテラルを含み、パラメーター・マーカーを含まない SQL ステートメントにのみ適用されます。 setDBStatementConcentrator は statementConcentrator Connection または DataSource プロパティー設定値をオーバーライドします。 setDBStatementConcentrator は、setDBStatementConcentrator の実行後に作成されたステートメントにのみ影響を与えます。

パラメーターの説明:

statementConcentratorUse

以下のいずれかの整数値になります。

DB2BaseDataSource.STATEMENT_CONCENTRATOR_OFF (1)

IBM Data Server Driver for JDBC and SQLJ は、データ・ソースのステートメント・コンセントレーター機能を使用しません。

DB2BaseDataSource.STATEMENT_CONCENTRATOR_WITH_LITERALS (2)

IBM Data Server Driver for JDBC and SQLJ は、データ・ソースのステートメント・コンセントレーター機能を使用します。

DB2BaseDataSource.STATEMENT_CONCENTRATOR_NOT_SET (0)

ステートメント・コンセントレーター機能に関するデータ・サーバーのデフォルト動作を使用可能にします。これはデフォルト値です。

ステートメント・コンセントレーター機能をサポートする Db2 on Linux、UNIX、および Windows システムのデータ・ソースの場合、データ・ソースで STMT_CONC 構成パラメーターが ON に設定されていると、この機能が使用されます。それ以外の場合は、ステートメント・コンセントレーター機能は使用されません。

ステートメント・コンセントレーター機能をサポートする Db2 for z/OS データ・ソースの場合、 statementConcentrator が設定されていないと、この機能は使用されません。

removeDB2JavaStoredProcedure

フォーマット：

public void DB2Connection.removeDB2JavaStoredProcedure(
  String jarId) 
  throws java.sql.SQLException

Linux、UNIX、および Windows システム上の Db2 サーバー上の sqlj.remove_jar ストアード・プロシージャーを呼び出して、JAR ファイルの定義をそのサーバーのカタログから削除します。

パラメーターの説明:

jarId: データベース内の JAR の名前。schema.JAR-id または JAR-id の形式になります。これは、SQL ステートメントで JAR を参照する場合に使用する名前です。 schemaを省略すると、データベース・システムは CURRENT SCHEMA 特殊レジスター内にある SQL 許可 ID を使用します。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

replaceDB2JavaStoredProcedure

フォーマット：

public void DB2Connection.replaceDB2JavaStoredProcedure(
  java.io.InputStream jarFile,
  int jarFileLength,
  String jarId) 
  throws java.sql.SQLException

Linux、UNIX、および Windows システム上の Db2 サーバー上の sqlj.replace_jar ストアード・プロシージャーを呼び出して、そのサーバーのカタログ内の JAR ファイルの定義を置き換えます。

パラメーターの説明:

jarFile: サーバー上で置き換えられる JAR ファイルの内容。
jarFileLength: サーバー上で置き換えられる JAR ファイルの長さ。
jarId: データベース内の JAR の名前。schema.JAR-id または JAR-id の形式になります。これは、SQL ステートメントで JAR を参照する場合に使用する名前です。 schemaを省略すると、データベース・システムは CURRENT SCHEMA 特殊レジスター内にある SQL 許可 ID を使用します。 JAR の所有者は、CURRENT SQLID 特殊レジスター内の許可 ID です。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

reuseDB2Connection (trusted connection reuse)

形式:

public void reuseDB2Connection(byte[] cookie,
  String user,
  String password,
  String usernameRegistry,
  byte[] userSecToken,
  String originalUser,
  java.util.Properties properties)
  throws java.sql.SQLException
public void reuseDB2Connection(byte[] cookie,
  org.ietf.GSSCredential gssCredential,
  String usernameRegistry,
  byte[] userSecToken,
  String originalUser,
  java.util.Properties properties)
  throws java.sql.SQLException

トラステッド接続は、以下の場合にサポートされます。

IBM Data Server Driver for JDBC and SQLJ タイプ 4 接続 :
- Linux、UNIX、および Windows システム上のDb2 バージョン 9.5 以降
- Db2 for z/OS バージョン 9.1 以降
- IBM Informix バージョン 11.70 以降
Db2 for z/OS バージョン 9.1 以降の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続

これらの形式の 2 番目の reuseDB2Connection は、 Db2 for z/OS上の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続には適用されません。

これらの形式の reuseDB2Connection は、トラステッド・アプリケーション・サーバーで使用され、新規ユーザーの代わりに、前から存在するトラステッド接続を再利用します。リセットできるプロパティー (新規ユーザー ID を含む) が渡されます。データベース・サーバーは、関連した物理接続をリセットします。 reuseDB2Connection が正常に実行する場合、異なるプロパティーを持つ接続が使用可能になり、新規ユーザーが即時使用することができます。

パラメーターの説明:

cookie: JDBC ドライバーが Connection インスタンスについて生成する固有の cookie。 cookie は、初期トラステッド接続を確立したアプリケーション・サーバーおよび基礎となる JDBC ドライバーにのみ認識されます。アプリケーション・サーバーは、プール接続インスタンスの作成時にドライバーによって作成された cookie を渡します。 JDBC ドライバーは、提供された cookie が基礎となるトラステッド物理接続の cookie と一致することを調べて、そのトラステッド物理接続を確立したアプリケーション・サーバーから発信された要求を確認します。 cookies が一致する場合、異なるプロパティーを持つ接続が使用可能になり、新規ユーザーが即時使用することができます。
user: データベース・システムがデータベース許可 ID を確立するために使用するクライアント ID。ユーザーがアプリケーション・サーバーによって認証されなかった場合、アプリケーション・サーバーは非認証ユーザーを表すクライアント ID を渡す必要があります。
password: userのパスワード。
gssCredential: データ・ソースが Kerberos セキュリティーを使用する場合に、別のプリンシパルから渡される委任証明書を指定します。
userNameRegistry: ワークステーション・ユーザー ID を z/OS RACF® ID にマップするマッピング・サービスを識別する名前。マッピング・サービスの例として、Integrated Security Services Enterprise Identity Mapping (EIM) があります。マッピング・サービスはプラグインによって定義されます。 userNameRegistry の有効な値はプラグイン・プロバイダーによって定義されます。 userNameRegistry が NULL の場合、user のマッピングは行われません。
userSecToken: クライアントのセキュリティー・トークン。この値は、 Db2 for z/OS アカウンティング・データの一部としてトレースされます。 userSecToken の内容はアプリケーション・サーバーによって記述され、データベース・システムによってアプリケーション・サーバー・セキュリティー・トークンとして参照されます。
originalUser: アプリケーション・サーバーによって使用されたオリジナル・ユーザー ID。
properties: 再利用される接続のプロパティー。

reuseDB2Connection (untrusted reuse with reauthentication)

形式:

public void reuseDB2Connection(String user,
  String password,
  java.util.Properties properties)
  throws java.sql.SQLException
public void reuseDB2Connection(
  org.ietf.jgss.GSSCredential gssCredential,
  java.util.Properties properties)
  throws java.sql.SQLException

これらの形式の最初の reuseDB2Connection は、 Db2 for z/OS上の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続ではサポートされていません。

これらの形式の 2 番目の reuseDB2Connection は、 Db2 for z/OS上の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続には適用されません。

異機種混合のプーリング環境では、これらの形式の reuseDB2Connection は、再認証後に既存の Connection インスタンスを再使用します。

パラメーターの説明:

user: 接続の確立に使用される許可 ID。
password: 接続の確立に使用される許可 ID のパスワード。
gssCredential: データ・ソースが Kerberos セキュリティーを使用する場合に、別のプリンシパルから渡される委任証明書を指定します。
properties: 再利用される接続のプロパティー。これらのプロパティーは、DB2Connection インスタンスですでに定義されているプロパティーをオーバーライドします。

reuseDB2Connection (untrusted or trusted reuse without reauthentication)

形式:

public void reuseDB2Connection(java.util.Properties properties)
  throws java.sql.SQLException

再認証なしで、既存の接続インスタンスを再利用します。このメソッドは、プロパティーが変更されない場合に Connection インスタンスを再利用することを意図しています。

トラステッド接続は、以下の場合にサポートされます。

IBM Data Server Driver for JDBC and SQLJ タイプ 4 接続 :
- Linux、UNIX、および Windows システム上のDb2 バージョン 9.5 以降
- Db2 for z/OS バージョン 9.1 以降
- IBM Informix バージョン 11.70 以降
Db2 for z/OS バージョン 9.1 以降の IBM Data Server Driver for JDBC and SQLJ タイプ 2 接続

このメソッドは、接続のダーティー再利用のためのものです。これは、オブジェクトがプールから再利用されると接続状態がリセットされないことを意味します。特殊レジスター設定およびプロパティー設定は、渡されるプロパティーによってオーバーライドされない限り、依然として有効です。グローバル一時表は削除されません。指定されなかったプロパティーは再初期化されません。分離レベル、自動コミット・モード、および読み取り専用モードなどの、JDBC 標準の一時プロパティーはすべて JDBC デフォルトにリセットされます。 user、password、databaseName、serverName、portNumber、planName、およびpkList などの特定のプロパティーは未変更のままです。

パラメーターの説明:

properties: 再利用される接続のプロパティー。これらのプロパティーは、DB2Connection インスタンスですでに定義されているプロパティーをオーバーライドします。

setDB2ClientAccountingInformation

フォーマット：

public void setDB2ClientAccountingInformation(String info)
  throws java.sql.SQLException

接続のアカウンティング情報を指定します。この情報は、クライアントのアカウンティングを目的としています。この値は、接続中に変更することもできます。

setDB2ClientAccountingToken は、 Db2 for z/OSへの接続にのみ適用されます。

パラメーターの説明:

info

ユーザー指定のアカウンティング情報。

最大長は、データ・サーバーのバージョンによって異なります。最大長については、 IBM Data Server Driver for JDBC and SQLJによるクライアント情報プロパティーのサポートを参照してください。

Java™ 空ストリング ("") または Java null 値がこのパラメーターに対して有効です。

重要: setDB2ClientAccountingInformation は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.setClientInfo を使用してください。

setDB2ClientApplicationInformation

フォーマット：

public String setDB2ClientApplicationInformation(String info)
  throws java.sql.SQLException

現在のクライアントのアプリケーション情報を指定します。

重要: setDB2ClientApplicationInformation は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.setClientInfo を使用してください。

パラメーターの説明:

info

ユーザー指定のアプリケーション情報。

Java 空ストリング ("") または Java null 値がこのパラメーターに対して有効です。

setDB2ClientCorrelationToken

フォーマット：

public String setDB2ClientCorrelationToken(String client-correlation-token)
  throws SQLException

企業内のさまざまな部門のビジネス・プロセスを関連付けることを可能にする固有値を指定します。

重要: setDB2ClientCorrelationToken は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.setClientInfo を使用してください。

パラメーターの説明:

client-correlation-token: 企業内のさまざまな部門のビジネス・プロセスを関連付けるために使用できる固有値。最大長は 255 バイトです。

setDB2ClientDebugInfo

形式:

public void setDB2ClientDebugInfo(String debugInfo)
  throws java.sql.SQLException
public void setDB2ClientDebugInfo(String mgrInfo,
  String traceInfo)
  throws java.sql.SQLException

CLIENT DEBUGINFO 接続属性の値を設定します。これはデータベース・システムに、接続を使用しているストアード・プロシージャーおよびユーザー定義関数がデバッグ・モードで実行していることを通知します。 CLIENT DEBUGINFO は、Db2 統合デバッガーにより使用されます。 CLIENT DEBUGINFO ストリング全体を設定するには、最初の形式を使用してください。 CLIENT DEBUGINFO ストリング内のセッション・マネージャーおよびトレース情報のみを変更するには、2 番目の形式を使用してください。

CLIENT DEBUGINFO 属性を、0 より長いストリングに設定する場合は、以下のいずれかの特権が必要です。

DEBUGSESSION 特権
SYSADM 権限

パラメーターの説明:

debugInfo

以下の形式の、最大で 254 バイトのストリング。

Mip:port,Iip,Ppid,Ttid,Cid,Llvl

ストリングの各部の意味は、以下のとおりです。

Mip: ポート: セッション・マネージャーの IP アドレスおよびポート番号。
IP (ip ): クライアント IP アドレス
PPID: クライアント・プロセス ID
Ttid (tid): クライアント・スレッド ID (オプション)
CID: データ接続生成済み ID
Lレベル: デバッグ・ライブラリー診断トレース・レベル。

以下に例を示します。

M9.72.133.89:8355,I9.72.133.89,P4552,T123,C1,L0

このストリングの詳細記述については、SET CLIENT DEBUGINFO の説明を参照してください。

mgrInfo

以下の形式のストリング。これは統合デバッガー・セッション・マネージャーの IP アドレスおよびポート番号を指定します。

Mip:port

以下に例を示します。

M9.72.133.89:8355

このストリングの詳細記述については、SET CLIENT DEBUGINFO の説明を参照してください。

trcInfo

以下の形式のストリング。これはデバッグ・ライブラリー診断トレース・レベルを指定します。

Llvl

以下に例を示します。

L0

このストリングの詳細記述については、SET CLIENT DEBUGINFO の説明を参照してください。

setDB2ClientProgramId

フォーマット：

public abstract void setDB2ClientProgramId(String program-ID) 
  throws java.sql.SQLException

Db2 for z/OS サーバー上で、接続用のユーザー定義プログラム ID を設定します。このプログラム ID は、呼び出し元を識別するために使用される 80 バイトのストリングです。

setDB2ClientProgramId は、 Linux、UNIX、および Windows システム上の Db2 または IBM Informix データ・サーバーには適用されません。

Db2 for z/OS サーバーは、ストリングを他の統計とともに IFCID 316 トレース・レコードに入れ、特定の SQL ステートメントに関連付けられているプログラムを識別できるようにします。

setDB2ClientUser

フォーマット：

public void setDB2ClientUser(String user)
  throws java.sql.SQLException

接続のための現行クライアントのユーザー名を指定します。この名前はクライアントのアカウンティングを目的としており、JDBC 接続のユーザー値ではありません。 JDBC 接続のユーザーの場合とは異なり、現在のクライアントのユーザー名は接続時に変更することができます。

パラメーターの説明:

user

現在のクライアントのユーザー ID。最大長は、サーバーによって異なります。

Java 空ストリング ("") または Java null 値がこのパラメーターに対して有効です。

重要: setDB2ClientUser は、 IBM Data Server Driver for JDBC and SQLJの JDBC 4.0 インプリメンテーションでは推奨されていません。代わりに、java.sql.Connection.setClientInfo を使用してください。

setDB2ClientWorkstation

フォーマット：

public void setDB2ClientWorkstation(String name)
  throws java.sql.SQLException

接続のための現在のクライアントのワークステーション名を指定します。この名前は、クライアントのアカウンティングを目的としています。現在のクライアントのワークステーション名は、接続時に変更することができます。

パラメーターの説明:

name

現在のクライアントのワークステーション名。

Java 空ストリング ("") または Java null 値がこのパラメーターに対して有効です。

setDB2CurrentPackagePath

フォーマット：

public void setDB2CurrentPackagePath(String packagePath)
  throws java.sql.SQLException

データベース・システムが JDBC および SQLJ パッケージを検索するコレクション ID のリストを指定します。

setDb2CurrentPackagePath メソッドは、Db2 データベース・システムへの接続にのみ適用されます。

パラメーターの説明:

packagePath: コレクション ID の、コンマで区切られたリスト。

setDB2CurrentPackageSet

フォーマット：

public void setDB2CurrentPackageSet(String packageSet)
  throws java.sql.SQLException

接続のためのコレクション ID を指定します。この値を設定すると、接続に使用される IBM Data Server Driver for JDBC and SQLJ インスタンスのコレクション ID も設定されます。

setDb2CurrentPackageSet メソッドは、Db2 データベース・システムへの接続にのみ適用されます。

パラメーターの説明:

packageSet: 接続のためのコレクション ID。 packageSet 値の最大長は 18 バイトです。このメソッドは、SQL SET CURRENT PACKAGESET ステートメントの実行の代替方法としてプログラム内で呼び出すことができます。

setDB2ProgressiveStreaming

フォーマット：

public void setDB2ProgressiveStreaming(int newSetting)
  throws java.sql.SQLException

接続で作成されるすべての ResultSet オブジェクトに関する連続ストリーミングを設定します。

パラメーターの説明:

newSetting

新しい連続ストリーミング設定。可能な値は以下のとおりです。

DB2BaseDataSource.YES (1): 連続ストリーミングを有効にします。データ・ソースで連続ストリーミングがサポートされない場合、これを設定しても効果はありません。
DB2BaseDataSource.NO (2): 連続ストリーミングを無効にします。

setGlobalSessionVariable

フォーマット：

public void setGlobalSessionVariable(String global-variable-name,
  String global-variable-value)
  throws java.sql.SQLException

グローバル変数の値を設定します。この方法は、 Db2 for z/OS バージョン 11 以降のデータ・サーバーへの接続にのみ適用されます。

パラメーターの説明:

global-variable-name: データ・サーバー上で定義されているグローバル変数の名前。
global-variable-value: そのグローバル変数に代入される値。

setJccLogWriter

形式:

public void setJccLogWriter(PrintWriter logWriter)
  throws java.sql.SQLException

public void setJccLogWriter(PrintWriter logWriter, int traceLevel)
  throws java.sql.SQLException

IBM Data Server Driver for JDBC and SQLJ トレースを使用可能または使用不可にするか、またはアクティブ接続中にトレースの宛先を変更します。

パラメーターの説明:

logWriter: IBM Data Server Driver for JDBC and SQLJ がトレース出力を書き込む、タイプ java.io.PrintWriter のオブジェクト。トレースをオフにするには、logWriter の値を null に設定します。
traceLevel: 収集するトレースのタイプを指定します。有効な値については、「 IBM Data Server Driver for JDBC and SQLJのプロパティー」の traceLevel プロパティーの説明を参照してください。

setSavePointUniqueOption

フォーマット：

public void setSavePointUniqueOption(boolean flag)
  throws java.sql.SQLException

アプリケーションがリカバリー単位内のセーブポイント名を再使用できるかどうかを指定します。可能な値は以下のとおりです。

はい

Connection.setSavepoint(savepoint-name) メソッドでは、同じリカバリー単位の中で savepoint-name に同じ値を複数回にわたって指定することができません。

いいえ

Connection.setSavepoint(savepoint-name) メソッドでは、同じリカバリー単位の中で savepoint-name に同じ値を複数回にわたって指定できます。

false を指定した場合、Connection.setSavepoint(savepoint-name) メソッドの実行時に savepoint-name という名前のセーブポイントがリカバリー単位に既に存在していれば、データベース・マネージャーは既存のセーブポイントを破棄して savepoint-name という名前の新しいセーブポイントを作成します。

セーブポイントの再使用は、Connection.releaseSavepoint(savepoint-name) の実行と同じではありません。 Connection.releaseSavepoint(savepoint-name) は、savepoint-name およびそれ以降に設定されたセーブポイントをすべて解放します。

updateDB2XmlSchema

フォーマット：

public void updateDB2XmlSchema(String[] targetSqlIdSchema,
  String[] targetSqlIdName,
  String[] sourceSqlIdSchema,
  String[] sourceSqlIdName,
  String[] xmlSchemaLocations,
  boolean dropSourceSchema)
  throws SQLException

XML スキーマの内容を、XML スキーマ・リポジトリー内の別の XML スキーマの内容で更新し、オプションでソース・スキーマをドロップします。ターゲット XML スキーマ内のスキーマ文書は、ソース XML スキーマからのスキーマ文書で置き換えられます。 updateDB2XmlSchema を呼び出す前に、ソースおよびターゲットの XML スキーマの登録を完了させておく必要があります。

ターゲット XML スキーマの更新には、SQL ALTERIN 特権が必要です。ソース XML スキーマのドロップには、SQL DROPIN 特権が必要です。

パラメーターの説明:

targetSqlIdSchema: 更新される登録済み XML スキーマの SQL スキーマ名。 targetSqlIdSchema は最大長が 128 バイトの String 値です。
targetSqlIdName: 更新される登録済み XML スキーマの名前。 targetSqlIdName は最大長が 128 バイトの String 値です。
sourceSqlIdSchema: ターゲット XML スキーマの更新に使用される、登録済み XML スキーマの SQL スキーマ名。 sourceSqlIdSchema は最大長が 128 バイトの String 値です。
sourceSqlIdName: ターゲット XML スキーマの更新に使用される、登録済み XML スキーマの名前。 sourceSqlIdName は最大長が 128 バイトの String 値です。
dropSourceSchema: ターゲット XML スキーマの更新後にソース XML スキーマがドロップされるかどうかを示します。 dropSourceSchema はブール値です。falseがデフォルトです。

この方法は、 IBM Informix データ・ソースへの接続には適用されません。

zLoad

形式:

public LoadResult zLoad(String loadstmt,
  String dataFilename)
  throws SQLException

public LoadResult zLoad(String loadstmt,
  String dataFilename, 
  String utilid)
  throws SQLException

public LoadResult zLoad(String loadstmtOrFile, 
  boolean isLoadStmtInFile, 
  String dataFilename) 
  throws SQLException

public LoadResult zLoad(String loadstmtOrFile,
  boolean isLoadstmtInFile,
  String dataFilename,
  String utilid) 
  throws SQLException

Db2 for z/OS 表にデータをロードし、 LoadResult オブジェクトを返します。このオブジェクトには、データ・サーバーから返される LOAD メッセージと戻りコードが含まれます。

パラメーターの説明:

loadstmt: LOAD ステートメントを指定します。 loadstmt は最大長が 32704 バイトの String 値です。
dataFilename: Db2 for z/OS 表にロードする外部ファイルのファイル名を指定します。このファイルの内容が含まれます。 dataFilename は String 値です。
utilid: LOAD ステートメントのユーティリティー ID を指定します。 utilid は最大長が 16 バイトの String 値です。
loadstmtOrFile: LOAD ステートメント、または LOAD ステートメントが含まれているファイルのパスを指定します。
isLoadStmtInFile: LOAD ステートメントがファイル内にあるかどうかを指定します。

この方法は、 Db2 for z/OS バージョン 12 以降のデータ・サーバーへの接続にのみ適用されます。