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')"

参数

以下参数是必需参数：

以下参数为可选参数：

使用说明

如果您在使用 Amazon RDS 控制台或 Amazon CLI 创建 RDS for Db2 数据库实例时未指定数据库的名称，则可以通过调用 rdsadmin.create_database 来创建数据库。有关更多信息，请参阅 创建数据库实例。

特殊注意事项：

有关这些注意事项的更多信息，请参阅 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。

示例

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

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 数据库实例信息：

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 控制台或 Amazon 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 的单个文件或多个文件还原脱机备份：

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 - Monitor and troubleshoot Db2 database command。

输出限制为最大 2 GB。

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

示例

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

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

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

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

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

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

以下示例返回 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。

示例

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

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

以下示例强制应用程序句柄 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 数据库上配置归档日志保留期设置。

示例

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