Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

用于管理 RDS for Db2 数据库的存储过程

本主题中介绍的内置存储过程可管理 Amazon RDS for Db2 数据库。要运行这些过程，主用户必须先连接到 rdsadmin 数据库。

这些存储过程可用于执行各种任务。此列表并不详尽。

请参阅以下内置存储过程，了解其语法、参数、用法说明和示例。

rdsadmin.create_database

创建一个数据库。

语法

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

参数

以下参数是必需参数：

以下参数可选：

使用说明

如果您打算修改 db2_compatibility_vector 参数，请在创建数据库之前进行修改。有关更多信息，请参阅 设置 db2_compatibility_vector 参数。

特殊注意事项：

有关这些注意事项的更多信息，请参阅 IBM Db2 文档中的 CREATE DATABASE command。

在调用 rdsadmin.create_database 之前，必须连接到 rdsadmin 数据库。在以下示例中，将 master_username 和 master_password 替换为 RDS for Db2 数据库实例信息：

db2 connect to rdsadmin user master_username using master_password

有关检查创建数据库的状态的信息，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.create_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例创建一个名为 TESTJP 的数据库，该数据库具有适用于日本的 database_code_set、database_territory 和 database_collation 参数的正确组合：

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

rdsadmin.deactivate_database

停用数据库。

语法

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

参数

以下输出参数是必需参数：

以下输入参数是必需参数：

使用说明

您可以停用数据库以节省内存资源或进行其它数据库配置更改。要使已停用的数据库恢复联机，请调用 rdsadmin.activate_database 存储过程。

有关如何检查数据库停用状态的信息，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.deactivate_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例停用名为 TESTDB 的数据库。

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

rdsadmin.activate_database

激活数据库。

有关 rdsadmin.reactivate_database 与 rdsadmin.activate_database 的差异的更多信息，请参阅 使用说明。

语法

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

参数

以下输出参数是必需参数：

以下输入参数是必需参数：

使用说明

默认情况下，所有数据库在创建后都处于激活状态。如果停用独立数据库实例上的数据库以节省内存资源或进行其它数据库配置更改，请调用 rdsadmin.activate_database 存储过程以再次激活数据库。

有关如何检查数据库激活状态的信息，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.activate_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例激活名为 TESTDB 的数据库。

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

rdsadmin.reactivate_database

重新激活数据库。

有关 rdsadmin.activate_database 与 rdsadmin.reactivate_database 之间差异的更多信息，请参阅使用说明。

语法

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

参数

以下输出参数是必需参数：

以下输入参数是必需参数：

使用说明

调用 rdsadmin.reactivate_database 存储过程时，该存储过程首先通过调用 rdsadmin.deactivate_database 存储过程来停用数据库，然后通过调用 rdsadmin.activate_database 存储过程来激活数据库。

更改数据库配置后，您可能需要在 RDS for Db2 数据库实例上重新激活数据库。要确定是否需要重新激活数据库，请连接到该数据库并运行 db2 get db cfg show detail。

对于独立数据库实例上的数据库，您可以使用 rdsadmin.reactivate_database 存储过程来重新激活该数据库。或者，如果您已经调用了 rdsadmin.deactivate_database 存储过程，则可以改为调用 rdsadmin.activate_database 存储过程。

有关检查重新激活数据库的状态的信息，请参阅 rdsadmin.get_task_status。

要查看调用 rdsadmin.reactivate_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例重新激活名为 TESTDB 的数据库。

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

rdsadmin.drop_database

删除数据库。

语法

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

参数

以下参数是必需参数：

使用说明

仅当满足以下条件时，才可以通过调用 rdsadmin.drop_database 来删除数据库：

在调用 rdsadmin.drop_database 之前，必须连接到 rdsadmin 数据库。在以下示例中，将 master_username 和 master_password 替换为 RDS for Db2 数据库实例信息：

db2 connect to rdsadmin user master_username using master_password

有关如何检查数据库删除状态的信息，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.drop_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例删除名为 TESTDB 的数据库：

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

rdsadmin.update_db_param

更新数据库参数。

语法

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

参数

以下参数为必需参数：

使用说明

有关如何检查数据库参数更新状态的信息，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.update_db_param 时返回的错误消息，请参阅排查存储过程中的错误。

示例

示例 1：更新参数

以下示例将名为 TESTDB 的数据库的 archretrydelay 参数更新为 100：

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

示例 2：延迟对象验证

以下示例推迟了对在名为 TESTDB 的数据库上创建的对象的验证，以避免依赖性检查：

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

rdsadmin.set_configuration

配置数据库的特定设置。

语法

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

参数

以下参数为必需参数：

使用说明

下表显示了您可以使用 rdsadmin.set_configuration 控制的配置设置。

示例

示例 1：指定要创建的缓冲区操纵符的数量

以下示例将 RESTORE_DATABASE_PARALLELISM 配置设置为 8。

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

示例 2：指定要创建的缓冲区数量

以下示例将 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

从 Amazon S3 存储桶还原到 RDS for Db2 数据库实例。

语法

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

参数

以下输出参数是必需参数：

以下输入参数是必需参数：

使用说明

您可以使用此存储过程将 Db2 数据库迁移到 RDS for Db2 数据库实例。有关更多信息，请参阅 使用 Amazon 服务将数据从 Db2 迁移到 Amazon RDS for Db2。您也可以使用此存储过程创建同一数据库的多个副本但使用不同的数据库名称，这些副本使用相同的还原映像。

在调用存储过程之前，请查看以下注意事项：

要在还原数据库后使数据库联机并应用其他事务日志，请参阅rdsadmin.rollforward_database。

要了解数据库的还原状态，请参阅rdsadmin.get_task_status。

要查看调用 rdsadmin.restore_database 时返回的错误消息，请参阅排查存储过程中的错误。

示例

以下示例使用带有 s3_prefix backupfolder/SAMPLE.0.rdsdb.DBPART000.20230615010101 的单个文件或多个文件还原脱机备份：

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, 
    'rollforward_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。

示例

示例 1：使包含事务日志的数据库联机

以下示例向前滚动到包含事务日志的数据库的联机备份，然后使数据库联机：

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

示例 2：使不包含事务日志的数据库联机

以下示例向前滚动到不包含事务日志的数据库的联机备份，然后使数据库联机：

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

示例 3：不让包含事务日志的数据库联机

以下示例向前滚动到包含事务日志的数据库的联机备份，但不会使数据库联机：

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

示例 4：不让包含其他事务日志的数据库联机

以下示例向前滚动到包含其他事务日志的数据库的联机备份，但不会使数据库联机：

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_rollforward(
    ?,
    '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 - Monitor and troubleshoot Db2 database command。

输出限制为最大 2 GB。

有关检查收集关于数据库的信息的状态的信息，请参阅 rdsadmin.get_task_status。

示例

示例 1：返回数据库实例的正常运行时间

以下示例返回 RDS for Db2 数据库实例的正常运行时间：

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

示例 2：返回数据库的正常运行时间

以下示例返回名为 TESTDB 的数据库的正常运行时间：

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

示例 3：返回数据库实例的内存使用情况

以下示例返回 RDS for Db2 数据库实例的内存使用情况：

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

示例 4：返回数据库实例和数据库的内存集

以下示例返回 RDS for Db2 数据库实例和名为 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 command。

有关检查强制应用程序退出数据库的状态的信息，请参阅 rdsadmin.get_task_status。

示例

示例 1：指定所有应用程序

以下示例强制所有应用程序退出 RDS for Db2 数据库：

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

示例 2：指定多个应用程序

以下示例强制应用程序句柄 9991、8891 和 1192 退出 RDS for Db2 数据库：

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 分钟。如果您使用诸如 Amazon DMS [用于进行更改数据捕获（CDC）] 或 IBM Q Replication 之类的复制工具，建议您在这些工具中将日志保留期设置为 5 分钟以上。

您可以通过调用 rdsadmin.show_archive_log_retention 来查看当前的归档日志保留期设置。

您无法在 rdsadmin 数据库上配置归档日志保留期设置。

示例

示例 1：设置保留时间

以下示例将名为 TESTDB 的数据库的归档日志保留时间设置为 24 小时。

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

示例 2：禁用保留时间

以下示例禁用名为 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')"

rdsadmin.list_archive_log_information

返回有关归档日志文件的详细信息，例如指定数据库的各个日志文件的大小、创建日期和时间以及名称。它还返回数据库中日志文件使用的总存储量。

语法

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

参数

以下输出参数是必需参数：

以下输入参数是必需参数：

示例

以下示例返回名为 TESTDB 的数据库的归档日志信息。

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