Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Référence RDS des fonctions définies par l'utilisateur Amazon pour Db2
Les fonctions définies par l'utilisateur suivantes sont disponibles pour les instances Amazon RDS DB exécutant le moteur Db2.
rdsadmin.get_task_status
Renvoie le statut d'une tâche.
Syntaxe
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'))"
Paramètres
Les paramètres suivants sont facultatifs. Si vous ne fournissez aucun paramètre, la fonction définie par l'utilisateur renvoie le statut de toutes les tâches pour toutes les bases de données. Amazon RDS conserve l'historique des tâches pendant 35 jours.
task_id
-
ID de la tâche en cours d'exécution. Cet identifiant est renvoyé lorsque vous exécutez une tâche. Par défaut:
0
. database_name
-
Nom de la base de données pour laquelle la tâche est exécutée.
task_type
-
Type de tâche à interroger. Valeurs valides :
ADD_GROUPS
,ADD_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
.
Notes d’utilisation
Vous pouvez utiliser la fonction rdsadmin.get_task_status
définie par l'utilisateur pour vérifier l'état des tâches suivantes pour Amazon RDS for Db2. Cette liste n'est pas exhaustive.
-
Création, modification ou suppression d'un pool de mémoire tampon
-
Création, modification ou suppression d'un tablespace
-
Création ou suppression d'une base de données
-
Restauration d'une sauvegarde de base de données depuis Amazon S3
-
Prolongation progressive des journaux de base de données depuis Amazon S3
Exemples
L'exemple suivant affiche les colonnes renvoyées lors de rdsadmin.get_task_status
l'appel.
db2 "describe select * from table(rdsadmin.get_task_status())"
L'exemple suivant répertorie le statut de toutes les tâches.
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))"
L'exemple suivant répertorie le statut d'une tâche spécifique.
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))"
L'exemple suivant répertorie le statut d'une tâche et d'une base de données spécifiques.
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))"
L'exemple suivant répertorie le statut de toutes les ADD_GROUPS
tâches.
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'))"
L'exemple suivant répertorie le statut de toutes les tâches pour une base de données spécifique.
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))"
L'exemple suivant affiche les JSON valeurs sous forme de colonnes.
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"
Réponse
La fonction rdsadmin.get_task_status
définie par l'utilisateur renvoie les colonnes suivantes :
TASK_ID
-
ID de la tâche
TASK_TYPE
-
Cela dépend des paramètres d'entrée.
-
ADD_GROUPS
— Ajoute des groupes. -
ADD_USER
— Ajoute un utilisateur. -
ALTER_BUFFERPOOL
— Modifie un pool tampon. -
ALTER_TABLESPACE
— Modifie un tablespace. -
CHANGE_PASSWORD
— Modifie le mot de passe d'un utilisateur. -
COMPLETE_ROLLFORWARD
— Termine unerdsadmin.rollforward_database
tâche et active une base de données. -
CREATE_BUFFERPOOL
— Crée un pool de mémoire tampon. -
CREATE_DATABASE
— Crée une base de données. -
CREATE_ROLE
— Crée un rôle DB2 pour un utilisateur. -
CREATE_TABLESPACE
— Crée un tablespace. -
DROP_BUFFERPOOL
— Supprime un pool de mémoire tampon. -
DROP_DATABASE
— Supprime une base de données. -
DROP_TABLESPACE
— Supprime un tablespace. -
LIST_USERS
— Liste tous les utilisateurs. -
REMOVE_GROUPS
— Supprime des groupes. -
REMOVE_USER
— Supprime un utilisateur. -
RESTORE_DB
— Restaure une base de données complète. -
ROLLFORWARD_DB_LOG
— Exécute unerdsadmin.rollforward_database
tâche sur les journaux de base de données. -
ROLLFORWARD_STATUS
— Renvoie le statut d'unerdsadmin.rollforward_database
tâche. -
UPDATE_DB_PARAM
— Met à jour les paramètres des données.
-
DATABASE_NAME
-
Nom de la base de données à laquelle la tâche est associée.
COMPLETED_WORK_BYTES
-
Nombre d'octets restaurés par la tâche.
DURATION_MINS
-
Le temps nécessaire pour terminer la tâche.
LIFECYCLE
-
État de la tâche. Statuts possibles :
-
CREATED
— Une fois qu'une tâche est soumise à AmazonRDS, Amazon RDS définit le statut surCREATED
. -
IN_PROGRESS
— Après le démarrage d'une tâche, Amazon RDS définit le statut surIN_PROGRESS
. Le passage d'un statut à peut prendre jusqu'à 5 minutesIN_PROGRESS
.CREATED
-
SUCCESS
— Une fois qu'une tâche est terminée, Amazon RDS définit le statut surSUCCESS
. -
ERROR
— Si une tâche de restauration échoue, Amazon RDS définit le statut surERROR
. Pour plus d'informations sur cette erreur, consultezTASK_OUPUT
.
-
CREATED_BY
-
Celui
authid
qui a créé la commande. CREATED_AT
-
Date et heure de création de la tâche.
LAST_UPDATED_AT
-
Date et heure de dernière mise à jour de la tâche.
TASK_INPUT_PARAMS
-
Les paramètres varient en fonction du type de tâche. Tous les paramètres d'entrée sont représentés sous forme d'JSONobjet. Par exemple, les JSON clés de la
RESTORE_DB
tâche sont les suivantes :-
DBNAME
-
RESTORE_TIMESTAMP
-
S3_BUCKET_NAME
-
S3_PREFIX
-
TASK_OUTPUT
-
Informations supplémentaires sur la tâche. Si une erreur se produit lors de la restauration native, cette colonne contient des informations sur l'erreur.
Exemples de réponses
L'exemple de réponse suivant montre qu'une base de données appelée TESTJP
a été créée avec succès. Pour plus d'informations, consultez la procédure rdsadmin.create_database stockée.
`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`.
L'exemple de réponse suivant explique pourquoi la suppression d'une base de données a échoué. Pour plus d'informations, consultez la procédure rdsadmin.drop_database stockée.
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
L'exemple de réponse suivant montre la restauration réussie d'une base de données. Pour plus d'informations, consultez la procédure rdsadmin.restore_database stockée.
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
Renvoie une liste de toutes les bases de données exécutées sur une instance de base de données RDS for DB2.
Syntaxe
db2 "select * from table(rdsadmin.list_databases())"
Notes d’utilisation
Cette fonction définie par l'utilisateur ne précise pas si les bases de données sont activées ou désactivées.
Si vos bases de données ne figurent pas dans la liste, appelez la fonction rdsadmin.get_task_status définie par l'utilisateur et recherchez les messages d'erreur.
Réponse
La fonction rdsadmin.list_databases
définie par l'utilisateur renvoie les colonnes suivantes :
DATABASE_NAME
-
Nom d'une base de données.
CREATE_TIME
-
Date et heure de création de la base de données.
Exemples de réponses
L'exemple de réponse suivant montre une liste de bases de données et l'heure à laquelle elles ont été créées. rdsadmin
est une base de données RDS gérée par Amazon et qui apparaît toujours dans la sortie.
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