Referenz RDS für benutzerdefinierte Funktionen von Amazon for Db2

Die folgenden benutzerdefinierten Funktionen sind für RDS Amazon-DB-Instances verfügbar, auf denen die Db2-Engine ausgeführt wird.

rdsadmin.get_task_status

Gibt den Status einer Aufgabe zurück.

Syntax

db2 "select task_id, task_type, database_name, lifecycle,
    varchar(bson_to_json(task_input_params), 500) as task_params,
    cast(task_output as varchar(500)) as task_output
    from table(rdsadmin.get_task_status(task_id,'database_name','task_type'))"

Parameter

Die folgenden Parameter sind optional. Wenn Sie keine Parameter angeben, gibt die benutzerdefinierte Funktion den Status aller Aufgaben für alle Datenbanken zurück. Amazon RDS speichert den Aufgabenverlauf 35 Tage lang.

task_id

Die ID der Aufgabe, die gerade ausgeführt wird. Diese ID wird zurückgegeben, wenn Sie eine Aufgabe ausführen. Standard: 0.

database_name

Der Name der Datenbank, für die die Aufgabe ausgeführt wird.

task_type

Der Typ der abzufragenden Aufgabe. Gültige Werte: ADD_GROUPSADD_USER,ALTER_BUFFERPOOL,ALTER_TABLESPACE,CHANGE_PASSWORD,COMPLETE_ROLLFORWARD,CREATE_BUFFERPOOL,CREATE_DATABASE,,CREATE_ROLE,CREATE_TABLESPACE,DROP_BUFFERPOOL,DROP_DATABASE,DROP_TABLESPACE,LIST_USERS,REMOVE_GROUPS,REMOVE_USER,RESTORE_DB,ROLLFORWARD_DB_LOG,ROLLFORWARD_STATUS,UPDATE_DB_PARAM.

Nutzungshinweise

Sie können die rdsadmin.get_task_status benutzerdefinierte Funktion verwenden, um den Status der folgenden Aufgaben für Amazon RDS for Db2 zu überprüfen. Diese Liste ist nicht umfassend.

• Einen Pufferpool erstellen, ändern oder löschen

• Einen Tablespace erstellen, ändern oder löschen

• Eine Datenbank erstellen oder löschen

• Wiederherstellung eines Datenbank-Backups aus Amazon S3

• Datenbankprotokolle von Amazon S3 weiterleiten

Beispiele

Im folgenden Beispiel werden die Spalten angezeigt, die beim Aufruf rdsadmin.get_task_status zurückgegeben werden.

db2 "describe select * from table(rdsadmin.get_task_status())"

Im folgenden Beispiel wird der Status aller Aufgaben aufgeführt.

db2 "select task_id, task_type, database_name, lifecycle, 
    varchar(bson_to_json(task_input_params), 500) as task_params, 
    cast(task_output as varchar(500)) as task_output 
    from table(rdsadmin.get_task_status(null,null,null))"

Im folgenden Beispiel wird der Status einer bestimmten Aufgabe aufgeführt.

db2 "select task_id, task_type, database_name, 
    varchar(bson_to_json(task_input_params), 500) as task_params 
    from table(rdsadmin.get_task_status(1,null,null))"

Im folgenden Beispiel wird der Status einer bestimmten Aufgabe und Datenbank aufgeführt.

db2 "select task_id, task_type, database_name, 
    varchar(bson_to_json(task_input_params), 500) as task_params 
    from table(rdsadmin.get_task_status(2,'SAMPLE',null))"

Im folgenden Beispiel wird der Status aller ADD_GROUPS Aufgaben aufgeführt.

db2 "select task_id, task_type, database_name, 
    varchar(bson_to_json(task_input_params), 500) as task_params 
    from table(rdsadmin.get_task_status(null,null,'add_groups'))"

Im folgenden Beispiel wird der Status aller Aufgaben für eine bestimmte Datenbank aufgeführt.

db2 "select task_id, task_type, database_name, 
    varchar(bson_to_json(task_input_params), 500) as task_params 
    from table(rdsadmin.get_task_status(null,'testdb', null))"

Im folgenden Beispiel werden die JSON Werte als Spalten ausgegeben.

db2 "select varchar(r.task_type,25) as task_type, varchar(r.lifecycle,10) as lifecycle, r.created_at, u.* from 
    table(rdsadmin.get_task_status(null,null,'restore_db')) as r, json_table(r.task_input_params, 'strict $' columns(s3_prefix varchar(500) 
    null on empty, s3_bucket_name varchar(500) null on empty) error on error ) as U"

Antwort

Die rdsadmin.get_task_status benutzerdefinierte Funktion gibt die folgenden Spalten zurück:

TASK_ID

Die ID der Aufgabe.

TASK_TYPE

Hängt von den Eingabeparametern ab.

• ADD_GROUPS— Fügt Gruppen hinzu.

• ADD_USER— Fügt einen Benutzer hinzu.

• ALTER_BUFFERPOOL— Ändert einen Pufferpool.

• ALTER_TABLESPACE— Ändert einen Tablespace.

• CHANGE_PASSWORD — Ändert das Passwort eines Benutzers.

• COMPLETE_ROLLFORWARD— Schließt eine rdsadmin.rollforward_database Aufgabe ab und aktiviert eine Datenbank.

• CREATE_BUFFERPOOL— Erzeugt einen Pufferpool.

• CREATE_DATABASE— Erzeugt eine Datenbank.

• CREATE_ROLE— Erzeugt eine Db2-Rolle für einen Benutzer.

• CREATE_TABLESPACE— Erzeugt einen Tablespace.

• DROP_BUFFERPOOL— Löscht einen Pufferpool.

• DROP_DATABASE— Löscht eine Datenbank.

• DROP_TABLESPACE— Löscht einen Tablespace.

• LIST_USERS— Listet alle Benutzer auf.

• REMOVE_GROUPS— Entfernt Gruppen.

• REMOVE_USER— Löscht einen Benutzer.

• RESTORE_DB— Stellt eine vollständige Datenbank wieder her.

• ROLLFORWARD_DB_LOG— Führt eine rdsadmin.rollforward_database Aufgabe mit Datenbankprotokollen aus.

• ROLLFORWARD_STATUS — Gibt den Status einer rdsadmin.rollforward_database Aufgabe zurück.

• UPDATE_DB_PARAM— Aktualisiert die Datenparameter.

DATABASE_NAME

Der Name der Datenbank, mit der die Aufgabe verknüpft ist.

COMPLETED_WORK_BYTES

Die Anzahl der Byte, die durch die Aufgabe wiederhergestellt wurden.

DURATION_MINS

Die Zeit, die zum Abschließen der Aufgabe benötigt wurde.

LIFECYCLE

Der Status der Aufgabe. Mögliche Status:

• CREATED— Nachdem eine Aufgabe an Amazon übermittelt wurdeRDS, RDS setzt Amazon den Status aufCREATED.

• IN_PROGRESS— Nach dem Start einer Aufgabe RDS setzt Amazon den Status aufIN_PROGRESS. Es kann bis zu 5 Minuten dauern, bis sich ein Status von CREATED zu ändertIN_PROGRESS.

• SUCCESS— Nach Abschluss einer Aufgabe RDS setzt Amazon den Status aufSUCCESS.

• ERROR— Wenn eine Wiederherstellungsaufgabe fehlschlägt, RDS setzt Amazon den Status aufERROR. Weitere Informationen zu dem Fehler finden Sie unterTASK_OUPUT.

CREATED_BY

authidDerjenige, der den Befehl erstellt hat.

CREATED_AT

Datum und Uhrzeit der Erstellung der Aufgabe.

LAST_UPDATED_AT

Datum und Uhrzeit der letzten Aktualisierung der Aufgabe.

TASK_INPUT_PARAMS

Die Parameter unterscheiden sich je nach Aufgabentyp. Alle Eingabeparameter werden als JSON Objekt dargestellt. Die JSON Schlüssel für die RESTORE_DB Aufgabe lauten beispielsweise wie folgt:

• DBNAME

• RESTORE_TIMESTAMP

• S3_BUCKET_NAME

• S3_PREFIX

TASK_OUTPUT

Zusätzliche Informationen über die Aufgabe. Wenn bei der systemeigenen Wiederherstellung ein Fehler auftritt, enthält diese Spalte Informationen zu dem Fehler.

Beispiele für Antworten

Das folgende Antwortbeispiel zeigt, dass eine aufgerufene Datenbank erfolgreich erstellt TESTJP wurde. Weitere Informationen finden Sie in der rdsadmin.create_database gespeicherten Prozedur.

`1 SUCCESS CREATE_DATABASE RDSDB 2023-10-24-18.32.44.962689 2023-10-24-18.34.50.038523 1 TESTJP { "CODESET" : "IBM-437", "TERRITORY" : "JP", "COLLATION" : "SYSTEM", "AUTOCONFIGURE_CMD" : "", "PAGESIZE" : 4096 } 
2023-10-24-18.33.30.079048 Task execution has started.

2023-10-24-18.34.50.038523 Task execution has completed successfully`.

Das folgende Antwortbeispiel erklärt, warum das Löschen einer Datenbank fehlgeschlagen ist. Weitere Informationen finden Sie in der rdsadmin.drop_database gespeicherten Prozedur.

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

Das folgende Antwortbeispiel zeigt die erfolgreiche Wiederherstellung einer Datenbank. Weitere Informationen finden Sie in der rdsadmin.restore_database gespeicherten Prozedur.

1 RESTORE_DB  SAMPLE  SUCCESS   
                                         
{ "S3_BUCKET_NAME" : "amzn-s3-demo-bucket", "S3_PREFIX" : "SAMPLE.0.rdsdb3.DBPART000.20230413183211.001", "RESTORE_TIMESTAMP" : "20230413183211", "BACKUP_TYPE" : "offline" }                                                                                                                                                                                                                                                                                                                                                   

2023-11-06-18.31.03.115795 Task execution has started.
2023-11-06-18.31.04.300231 Preparing to download
2023-11-06-18.31.08.368827 Download complete. Starting Restore
2023-11-06-18.33.13.891356 Task Completed Successfully

rdsadmin.list_databases

Gibt eine Liste aller Datenbanken zurück, die auf einer RDS for Db2-DB-Instance laufen.

Syntax

db2 "select * from table(rdsadmin.list_databases())"

Nutzungshinweise

Diese benutzerdefinierte Funktion gibt nicht an, ob sich Datenbanken in einem aktivierten oder deaktivierten Zustand befinden.

Wenn Sie Ihre Datenbanken nicht in der Liste sehen, rufen Sie die rdsadmin.get_task_status benutzerdefinierte Funktion auf und suchen Sie nach Fehlermeldungen.

Antwort

Die rdsadmin.list_databases benutzerdefinierte Funktion gibt die folgenden Spalten zurück:

DATABASE_NAME

Der Name einer Datenbank.

CREATE_TIME

Datum und Uhrzeit der Erstellung der Datenbank.

Beispiele für Antworten

Das folgende Antwortbeispiel zeigt eine Liste von Datenbanken und die Zeiten, zu denen sie erstellt wurden. rdsadminist eine Datenbank, die Amazon RDS verwaltet und die immer in der Ausgabe erscheint.

DATABASE_NAME   CREATE_TIME
--------------- --------------------------
rdsadmin        2024-10-22-03.37.48.535671
TEST            2024-10-22-03.39.36.818679
TEST1           2024-10-22-03.57.15.218009
TEST2           2024-10-22-03.59.28.029556