CATALOG DATABASE コマンド

CATALOG DATABASE コマンドは、データベース・ロケーション情報をシステム・データベース・ディレクトリーに保管します。データベースは、ローカル・ワークステーションかリモート・データベース・パーティション・サーバーのどちらかに位置付けることができます。 CATALOG DATABASEコマンドを使用して、データベースの場所に関係なく、カタログ化されていないデータベースを再カタログしたり、1つのDATABASEに対して複数の別名を維持したりすることもできます。

重要: FIPS 140-3 認証暗号モジュールが Db2の将来のバージョンで導入された場合、 SERVER_ENCRYPT 認証タイプは非推奨になり、 SERVER_ENCRYPT_AES 認証タイプは厳密な FIPS モードでは機能しません。非推奨について詳しくは、ご使用のサーバーの認証方式を参照してください。

範囲

パーティション・データベース環境では、ローカル・データベースがシステム・データベース・ディレクトリーにカタログされる場合、このコマンドは、データベースが配置されているサーバーのデータベース・パーティションから発行する必要があります。

許可

以下の権限のいずれか。

SYSADM
SYSCTRL

必要な接続

None. ディレクトリー操作は、ローカル・ディレクトリーだけに影響します。

コマンド構文

Notes:

¹ This option is available starting from Db2® version 11.5.4.

コマンド・パラメーター

DATABASE database-name

カタログするデータベースの名前を指定します。

AS alias

カタログされるデータベースの代替名として別名を指定します。別名が指定されていない場合、データベース・マネージャーは別名として database-name を使用します。

ON path | drive

カタログするデータベースが存在するパスを指定します。 Windows オペレーティング・システムでは、代わりに、カタログされるデータベースが存在するドライブの文字を指定する場合があります (特定のパスではなく、ドライブ上に作成された場合)。

AT NODE nodename

カタログするデータベースが常駐するデータベース・パーティション・サーバーの名前を指定します。この名前は、ノード・ディレクトリー内の項目名と一致させてください。指定されたノード名がノード・ディレクトリーに存在しない場合、警告が返されますが、データベースはシステム・データベース・ディレクトリーにカタログされます。カタログしたデータベースへの接続が必要なときは、ノード名をノード・ディレクトリーにカタログしなければなりません。

AUTHENTICATION

リモート・データベースの認証値は保管されますが (LIST DATABASE DIRECTORY コマンドからの出力に現れる)、ローカル・データベースの認証値は保管されません。

認証タイプを指定すると、パフォーマンスが向上する場合があります。

SERVER

認証が、ターゲット・データベースを含むデータベース・パーティション・サーバーで行われるということを指定します。

CLIENT

認証が、アプリケーションを呼び出すデータベース・パーティション・サーバーで行われるということを指定します。

SERVER_ENCRYPT

認証が、ターゲット・データベースを含むデータベース・パーティション・サーバーで行われるということ、およびユーザー ID とパスワードが送信元で暗号化されることを指定します。送信元でカタログされる認証タイプによって指定されるとおり、ユーザー ID とパスワードはターゲットで暗号化解除されます。

KERBEROS

Kerberos セキュリティー・メカニズムで認証することを指定します。

TARGET PRINCIPAL principalname: ターゲット・サーバーの完全修飾 Kerberos プリンシパル名。つまり、 name/instance@REALMという形式の、 Db2 インスタンス所有者の完全修飾 Kerberos プリンシパル。 Windows Server 2003 の場合、これは userid@DOMAIN、 userid@xxx.xxx.xxx.com または domain\useridの形式の Db2 サーバー・サービスのログオン・アカウントです。

GSSPLUGIN

外部GSS API ベースのプラグイン・セキュリティー・メカニズムで認証することを指定します。

SERVER_ENCRYPT_AES

認証が、ターゲット・データベースを含むデータベース・パーティション・サーバーで行われるということ、および Advanced Encryption Standard (AES) 暗号化アルゴリズムによってユーザー ID とパスワードが送信元で暗号化されてターゲットで暗号化解除されることを指定します。

TOKEN: 注: このオプションは、 Db2 バージョン 11.5.4以降で使用可能です。
トークンを使用して、ターゲット・データベースを含むデータベース・パーティション・サーバーで認証することを指定します。トークンのタイプは、CONNECT ステートメントの一部として指定します。

WITH "comment-string"

システム・データベース・ディレクトリー内のデータベースまたはデータベース項目について記述します。コメント・ストリングの最大長は 30 文字です。キャリッジリターンまたは改行文字は使用できません。コメント・テキストは必ず二重引用符で囲んでください。

例

   db2 catalog database sample on /databases/sample
      with "Sample Database"

使用上の注意

データベースの作成時に、Db2 は自動的にそれらをカタログします。これは、ローカル・データベース・ディレクトリーにデータベースの項目をカタログし、システム・データベース・ディレクトリーに別の項目をカタログします。データベースがリモート・クライアント (または同じマシン上の別のインスタンスから実行されているクライアント) から作成される場合、クライアント・インスタンスのシステム・データベース・ディレクトリーにも項目が作成されます。

パスもデータベース・パーティション・サーバー名も指定しない場合、データベースはローカルであると見なされます。この場合、データベースのロケーションは、 dftdbpath データベース・マネージャー構成パラメーターの値であると想定されます。

データベース・マネージャー・インスタンスと同じデータベース・パーティション・サーバー上のデータベースは、間接項目としてカタログされます。その他のデータベース・パーティション・サーバーのデータベースは、リモート入力としてカタログされます。

CATALOG DATABASE コマンドは、システム・データベース・ディレクトリーが存在しない場合は自動的に作成します。システム・データベース・ディレクトリーは、使用されているデータベース・マネージャー・インスタンスを含むパスに保管され、データベースの外部で保守されます。

LIST DATABASE DIRECTORY コマンドを使用して、システム・データベース・ディレクトリーの内容をリストします。ローカル・データベース・ディレクトリーの内容をリストする場合は、 LIST DATABASE DIRECTORY ON path を使用します。 path はデータベースが作成された場所です。

ディレクトリーのキャッシュが有効な場合、データベース、ノード、および DCS ディレクトリー・ファイルはメモリーにキャッシュされます。ディレクトリー・キャッシングが使用可能かどうかを確認するには、 GET DATABASE MANAGER CONFIGURATION コマンドの出力で dir_cache ディレクトリー・キャッシュ・サポート構成パラメーターの値を確認します。アプリケーションのディレクトリー・キャッシュは、最初のディレクトリー検索時に作成されます。キャッシュは、アプリケーションがディレクトリファイルのいずれかを変更した場合にのみ更新されるため、他のアプリケーションのディレクトリ変更は、アプリケーション再起動まで有効にならない場合があります。

CLP のディレクトリー・キャッシュを最新表示するには、TERMINATE コマンドを使用します。データベース・マネージャーの共有キャッシュをリフレッシュするには、データベース・マネージャーを停止 (db2stop) してから再始動 (db2start) します。別のアプリケーション用のディレクトリー・キャッシュを最新にするには、そのアプリケーションを停止させてから再始動させてください。

pureScale 環境では、 CATALOG DATABASE コマンドの後に db2cluster -cm -add -database_mounts database-name コマンドを実行する必要があります。