RDS for Db2 のデータベースのストアドプロシージャ

以下のストアドプロシージャでは、Amazon RDS for Db2 のデータベースを管理します。これらのプロシージャを実行する場合、マスターユーザーはまず rdsadmin データベースに接続する必要があります。

rdsadmin.create_database

データベースを作成します。

構文

db2 "call rdsadmin.create_database('database_name')"

パラメータ

以下のパラメータは必須です。

以下のパラメータはオプションです。

使用に関する注意事項

Amazon RDS コンソールまたは AWS CLI を使用して RDS for Db2 DB インスタンスを作成したときにデータベースの名前を指定しなかった場合は、rdsadmin.create_database を呼び出してデータベースを作成できます。詳細については、「DB インスタンスの作成」を参照してください。

特別な考慮事項:

これらのコマンドの詳細については、 IBM Db2 ドキュメントの「CREATE DATABASE command」を参照してください。

rdsadmin.create_database を呼び出す前に、rdsadmin データベースに接続する必要があります。次の例では、master_username と master_password を RDS for Db2 DB インスタンス情報に置き換えます。

db2 connect to rdsadmin user master_username using master_password

データベースの作成ステータスを確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、日本向けの database_code_set パラメータ、database_territory パラメータ、および database_collation パラメータを適切に組み合わせた TESTJP というデータベースを作成します。

db2 "call rdsadmin.create_database('TESTJP', 4096, 'IBM-437', 'JP', 'SYSTEM')"

rdsadmin.drop_database

データベースを削除します。

構文

db2 "call rdsadmin.drop_database('database_name')"

パラメータ

以下のパラメータは必須です。

使用に関する注意事項

次の条件が満たされた場合にのみ、rdsadmin.drop_database を呼び出してデータベースを削除できます。

rdsadmin.drop_database を呼び出す前に、rdsadmin データベースに接続する必要があります。次の例では、master_username と master_password を RDS for Db2 DB インスタンス情報に置き換えます。

db2 connect to rdsadmin user master_username using master_password

データベースの削除ステータスを確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、TESTDB という名前のデータベースを削除します。

db2 "call rdsadmin.drop_database('TESTDB')"

レスポンスの例

間違ったデータベース名を渡すと、ストアドプロシージャは次の例のレスポンスを返します。

SQL0438N Application raised error or warning with diagnostic text: "Cannot
drop database. Database with provided name does not exist". SQLSTATE=99993

Amazon RDS コンソールまたは AWS CLI を使用してデータベースを作成すると、ストアドプロシージャは次の例のレスポンスを返します。

Return Status = 0

Return Status = 0 を受け取った後、 rdsadmin.get_task_status ストアドプロシージャを呼び出します。次の例のように、ステータスを説明するレスポンスが返されます。

1 ERROR DROP_DATABASE RDSDB 2023-10-10-16.33.03.744122 2023-10-10-16.33.30.143797 - 2023-10-10-16.33.30.098857 Task execution has started.
2023-10-10-16.33.30.143797 Caught exception during executing task id 1, Aborting task. 
Reason Dropping database created via rds CreateDBInstance api is not allowed. 
Only database created using rdsadmin.create_database can be dropped

rdsadmin.update_db_param

データベースパラメータを更新します。

構文

db2 "call rdsadmin.update_db_param(
    'database_name', 
    'parameter_to_modify', 
    'changed_value)"

パラメータ

以下のパラメータは必須です。

使用に関する注意事項

データベースパラメータの更新ステータスを確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、TESTDB というデータベースで archretrydelay パラメータを 100 に更新します。

db2 "call rdsadmin.update_db_param(
    'TESTDB', 
    'archretrydelay', 
    '100')"

次の例では、依存関係のチェックを回避するために、TESTDB というデータベースにおいて作成したオブジェクトの検証を延期します。

db2 "call rdsadmin.update_db_param(
    'TESTDB', 
    'auto_reval', 
    'deferred_force')"

レスポンスの例

サポートされていない、または変更できないデータベース設定パラメータを変更しようとすると、ストアドプロシージャは次のレスポンスの例を返します。

SQL0438N Application raised error or warning with diagnostic text: "Parameter
is either not supported or not modifiable to customers". SQLSTATE=99993

rdsadmin.set_configuration

データベースの特定の設定を構成します。

構文

db2 "call rdsadmin.set_configuration(
    'name',  
    'value')"

パラメータ

以下のパラメータは必須です。

使用に関する注意事項

次の表は、rdsadmin.set_configuration で制御できる構成設定を示しています。

例

次の例では、RESTORE_DATABASE_PARALLELISM を 8 に設定します。

db2 "call rdsadmin.set_configuration(
    'RESTORE_DATABASE_PARALLELISM', 
    '8')"

次の例では、RESTORE_DATABASE_NUM_BUFFERS を 150 に設定します。

db2 "call rdsadmin.set_configuration(
    'RESTORE_DATABASE_NUM_BUFFERS', 
    '150')"

rdsadmin.show_configuration

ストアドプロシージャ rdsadmin.set_configuration を使用して指定できる現在の設定を返します。

構文

db2 "call rdsadmin.show_configuration(
    'name')"

パラメータ

次のパラメータはオプションです。

使用に関する注意事項

構成設定の名前を指定しないと、rdsadmin.show_configuration は、ストアドプロシージャ rdsadmin.set_configuration を使用して設定できるすべての構成設定に関する情報を返します。

例

次の例では、現在の RESTORE_DATABASE_PARALLELISM 設定に関する情報を返します。

db2 "call rdsadmin.show_configuration(
    'RESTORE_DATABASE_PARALLELISM')"

rdsadmin.restore_database

データベースを復元します。

構文

db2 "call rdsadmin.restore_database(
    ?,
    'database_name', 
    's3_bucket_name', 
    's3_prefix', 
    restore_timestamp, 
    'backup_type')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要となります。

使用に関する注意事項

ストアドプロシージャを呼び出す前に、以下の考慮事項を確認してください。

データベースをオンラインにして、データベースを復元した後に追加のトランザクションログを適用するには、「rdsadmin.rollforward_database」を参照してください。

データベースの復元状況の確認については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、s3_prefix backupfolder/SAMPLE.0.rdsdb.DBPART000.20230615010101 を持つ 1 つ以上のファイルでオフラインバックアップを復元します。

db2 "call rdsadmin.restore_database(
    ?,
    'SAMPLE',
    'amzn-s3-demo-bucket',
    'backupfolder/SAMPLE.0.rdsdb.DBPART000.20230615010101',
    20230615010101,
    'OFFLINE')"

rdsadmin.rollforward_database

rdsadmin.restore_database を呼び出して、データベースをオンラインにし、データベースを復元した後に追加のトランザクションログを適用します。

構文

db2 "call rdsadmin.rollforward_database(
    ?,
    'database_name',
    's3_bucket_name', 
    s3_prefix, 
    'rollfoward_to_option', 
    'complete_rollforward')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要となります。

次の入力パラメータは、オプションです。

使用に関する注意事項

rdsadmin.restore_database を呼び出した後、rollforward_database を呼び出して S3 バケットからのアーカイブログを適用する必要があります。このストアドプロシージャを使用して、rdsadmin.restore_database を呼び出した後に追加のトランザクションログを復元することもできます。

complete_rollforward を FALSE に設定すると、データベースは ROLL-FORWARD PENDING 状態になり、オフラインになります。データベースをオンラインにするには、rdsadmin.complete_rollforward を呼び出す必要があります。

データベースのロールフォワードステータスを確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、トランザクションログを使用してデータベースのオンラインバックアップにロールフォワードし、データベースをオンラインにします。

db2 "call rdsadmin.rollforward_database(
    ?,
    null,
    null,
    'END_OF_LOGS',
    'TRUE')"

次の例では、トランザクションログなしでデータベースのオンラインバックアップにロールフォワードし、データベースをオンラインにします。

db2 "call rdsadmin.rollforward_database(
    ?,
    'TESTDB',
    'amzn-s3-demo-bucket',
    'logsfolder/,
    'END_OF_BACKUP',
    'TRUE')"

次の例では、トランザクションログを使用してデータベースのオンラインバックアップにロールフォワードします。ただし、データベースはオンラインにしません。

db2 "call rdsadmin.rollforward_database(
    ?,
    'TESTDB',
    null,
    'onlinebackup/TESTDB',
    'END_OF_LOGS',
    'FALSE')"

次の例では、追加のトランザクションログを使用してデータベースのオンラインバックアップにロールフォワードします。ただし、データベースはオンラインにしません。

db2 "call rdsadmin.rollforward_database(
    ?,
    'TESTDB',
    'amzn-s3-demo-bucket',
    'logsfolder/S0000155.LOG',
    'END_OF_LOGS',
    'FALSE')"

rdsadmin.complete_rollforward

データベースを ROLL-FORWARD PENDING 状態からオンラインにします。

構文

db2 "call rdsadmin.complete_rollforward(
    ?,
    'database_name')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要です。

使用に関する注意事項

complete_rollforward を FALSE に設定して rdsadmin.rollforward_database を呼び出すと、データベースは ROLL-FORWARD PENDING 状態になり、オフラインになります。ロールフォワードプロセスを完了し、データベースをオンラインにするには、rdsadmin.complete_rollforward を呼び出します。

ロールフォワードプロセスの完了ステータスを確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、TESTDB データベースをオンラインにします。

db2 "call rdsadmin.complete_rollfoward(
    ?,
    'TESTDB')"

rdsadmin.db2pd_command

RDS for Db2 データベースに関する情報を収集します。

構文

db2 "call rdsadmin.db2pd_command('db2pd_cmd')"

パラメータ

次の入力パラメータが必要です。

使用に関する注意事項

このストアドプロシージャは、RDS for Db2 データベース のモニタリングとトラブルシューティングに役立つ情報を収集します。

ストアドプロシージャは、IBM db2pd ユーティリティを使用してさまざまなコマンドを実行します。db2pd ユーティリティには SYSADM 権限が必要です (RDS for Db2 マスターユーザーにはない権限です)。ただし、Amazon RDS ストアドプロシージャを使用すると、マスターユーザーはユーティリティを使用してさまざまなコマンドを実行できます。このユーティリティの詳細については、IBM Db2 ドキュメントの「db2pd - Db2 データベースのモニターおよびトラブルシューティングコマンド」を参照してください。

出力は最大 2 GB に制限されています。

データベースに関する情報の収集状況を確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例は、RDS for Db2 DB インスタンスの稼働時間を返します。

db2 "call rdsadmin.db2pd_command('-')"

次の例は、TESTDB という名前のデータベースの稼働時間を返します。

db2 "call rdsadmin.db2pd_command('-db TESTDB -')"

次の例は、RDS for Db2 DB インスタンスのメモリ使用量を返します。

db2 "call rdsadmin.db2pd_command('-dbptnmem')"

次の例は、RDS for Db2 DB インスタンスとデータベース TESTDB のメモリセットを返します。

db2 "call rdsadmin.db2pd_command('-inst -db TESTDB -memsets')"

rdsadmin.force_application

RDS for Db2 データベースからアプリケーションを強制的に削除します。

構文

db2 "call rdsadmin.force_application(
    ?,
    'applications')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要です。

使用に関する注意事項

このストアドプロシージャは、すべてのアプリケーションをデータベースから強制的に削除して、メンテナンスを実行できるようにします。

ストアドプロシージャは、IBM FORCE APPLICATION コマンドを使用します。FORCE APPLICATION コマンドには SYSADM、SYSMAINT、または SYSCTRL 権限が必要です (RDS for Db2 マスターユーザーにはない権限です)。ただし、Amazon RDS ストアドプロシージャを使用すると、マスターユーザーはコマンドを使用できます。詳細については、IBM Db2 ドキュメントの「FORCE APPLICATION コマンド」を参照してください。

データベースからのアプリケーションの強制的な削除に関する状態を確認する方法については、「rdsadmin.get_task_status」を参照してください。

例

次の例では、すべてのアプリケーションを RDS for Db2 データベースから強制的に削除します。

db2 "call rdsadmin.force_application(
    ?,
    'ALL')"

次の例では、RDS for Db2 データベースからアプリケーションハンドル 9991、8891、1192 を強制的に削除します。

db2 "call rdsadmin.force_application(
    ?,
    '9991, 8891, 1192')"

rdsadmin.set_archive_log_retention

指定した RDS for Db2 データベースのアーカイブログファイルを保持する時間 (時間単位) を設定します。

構文

db2 "call rdsadmin.set_archive_log_retention(
    ?,            
    'database_name',  
    'archive_log_retention_hours')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要となります。

使用に関する注意事項

デフォルトでは、RDS for Db2 はログを 5 分間保持します。変更データキャプチャ (CDC) の AWS DMS や IBM Q Replication などのレプリケーションツールを使用する場合は、これらのツールでログ保持を 5 分以上設定することをお勧めします。

rdsadmin.show_archive_log_retention を呼び出すと、現在のアーカイブログ保持の設定を表示できます。

rdsadmin データベースに対してアーカイブログ保持の設定を構成することはできません。

例

次の例は、TESTDB というデータベースのアーカイブログ保持時間を 24 時間に設定しています。

db2 "call rdsadmin.set_archive_log_retention(
    ?,
    'TESTDB', 
    '24')"

次の例では、TESTDB というデータベースのアーカイブログ保持を無効にします。

db2 "call rdsadmin.set_archive_log_retention(
    ?,
    'TESTDB', 
    '0')"

rdsadmin.show_archive_log_retention

指定したデータベースに関する現在のアーカイブログ保持の設定を返します。

構文

db2 "call rdsadmin.show_archive_log_retention(
    ?,
    'database_name')"

パラメータ

次のアウトプットパラメータが必要です。

次の入力パラメータが必要です。

例

次の例は、TESTDB というデータベースのアーカイブログ保持の設定を示しています。

db2 "call rdsadmin.show_archive_log_retention(
    ?
    'TESTDB')"