

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# Informazioni di riferimento sulle funzioni definite dall’utente di Amazon RDS per Db2
<a name="db2-user-defined-functions"></a>

Le funzioni definite dall’utente descritte di seguito sono disponibili per le istanze database Amazon RDS che eseguono il motore Db2. 

**Topics**
+ [rdsadmin.get\$1task\$1status](#db2-udf-get-task-status)
+ [rdsadmin.list\$1databases](#db2-udf-list-databases)
+ [rdsadmin.list\$1modifiable\$1db\$1params](#db2-udf-list-modi-db-params)

## rdsadmin.get\$1task\$1status
<a name="db2-udf-get-task-status"></a>

Restituisce lo stato di un’attività.

### Sintassi
<a name="db2-udf-get-task-status-syntax"></a>

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

### Parameters
<a name="db2-udf-get-task-status-parameters"></a>

I parametri seguenti sono facoltativi. Se non è specificato alcun parametro, la funzione definita dall’utente restituisce lo stato di tutte le attività per tutti i database. Amazon RDS mantiene la cronologia delle attività per 35 giorni.

*task\$1id*  
L’ID dell’attività in esecuzione. Questo ID viene restituito durante l’esecuzione di un’attività. Default: `0`. 

*database\$1name*  
Il nome del database per cui viene eseguita l’attività.

*task\$1type*  
Il tipo di attività su cui eseguire query. Valori validi: `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`.

### Note per l’utilizzo
<a name="db2-udf-get-task-status-usage-notes"></a>

È possibile utilizzare la funzione `rdsadmin.get_task_status` definita dall’utente per verificare lo stato delle seguenti attività in Amazon RDS per Db2. Questo elenco non è completo.
+ Creazione, modifica o eliminazione di un pool di buffer
+ Creazione, modifica o eliminazione di un tablespace
+ Creazione o eliminazione di un database
+ Ripristino di un backup di database da Amazon S3
+ Roll forward dei log di database da Amazon S3

### Esempi
<a name="db2-udf-get-task-status-examples"></a>

L’esempio seguente mostra le colonne restituite quando viene chiamata la funzione `rdsadmin.get_task_status`.

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

L’esempio seguente elenca lo stato di tutte le attività.

```
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’esempio seguente elenca lo stato di un’attività specifica.

```
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’esempio seguente elenca lo stato di un’attività e di un database specifici.

```
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’esempio seguente elenca lo stato di tutte le attività `ADD_GROUPS`.

```
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’esempio seguente elenca lo stato di tutte le attività per un database specifico. 

```
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’esempio seguente restituisce i valori JSON come colonne.

```
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"
```

### Risposta
<a name="db2-udf-get-task-status-response"></a>

La funzione `rdsadmin.get_task_status` definita dall’utente restituisce le seguenti colonne:

`TASK_ID`  
L'ID dell'attività.

`TASK_TYPE`  
Dipende dai parametri di input.  
+ `ADD_GROUPS`: aggiunge gruppi.
+ `ADD_USER`: aggiunge un utente.
+ `ALTER_BUFFERPOOL`: modifica un pool di buffer.
+ `ALTER_TABLESPACE`: modifica un tablespace.
+ `CHANGE_PASSWORD `: modifica la password di un utente.
+ `COMPLETE_ROLLFORWARD`: completa un’attività `rdsadmin.rollforward_database` e attiva un database.
+ `CREATE_BUFFERPOOL`: crea un pool di buffer.
+ `CREATE_DATABASE`: crea un database.
+ `CREATE_ROLE`: crea un ruolo Db2 per un utente.
+ `CREATE_TABLESPACE`: crea un tablespace.
+ `DROP_BUFFERPOOL`: elimina un pool di buffer.
+ `DROP_DATABASE`: elimina un database.
+ `DROP_TABLESPACE`: elimina un tablespace.
+ `LIST_USERS`: elenca tutti gli utenti.
+ `REMOVE_GROUPS`: rimuove gruppi.
+ `REMOVE_USER`: rimuove un utente.
+ `RESTORE_DB`: ripristina un database completo.
+ `ROLLFORWARD_DB_LOG`: esegue un’attività `rdsadmin.rollforward_database` sui log del database.
+ `ROLLFORWARD_STATUS `: restituisce lo stato di un’attività `rdsadmin.rollforward_database`.
+ `UPDATE_DB_PARAM`: aggiorna i parametri dei dati.

`DATABASE_NAME`  
Il nome del database a cui è associata l’attività.

`COMPLETED_WORK_BYTES`  
Il numero di byte ripristinati dall’attività.

`DURATION_MINS`  
Il tempo necessario per completare l’attività. 

`LIFECYCLE`  
Lo stato dell'attività. Stati possibili:  
+ `CREATED`: dopo l’invio di un’attività ad Amazon RDS, lo stato viene impostato su `CREATED`.
+ `IN_PROGRESS`: dopo l’avvio di un’attività, lo stato viene impostato su `IN_PROGRESS`. Possono essere necessari fino a 5 minuti perché lo stato passi da `CREATED` a `IN_PROGRESS`.
+ `SUCCESS`: al termine di un’attività, lo stato viene impostato su `SUCCESS`.
+ `ERROR`: se un’attività di ripristino non riesce, lo stato viene impostato su `ERROR`. Per ulteriori informazioni sull’errore, consulta `TASK_OUPUT`. 

`CREATED_BY`  
L’`authid` che ha creato il comando.

`CREATED_AT`  
La data e l’ora di creazione dell’attività.

`LAST_UPDATED_AT`  
La data e l’ora dell’ultimo aggiornamento dell’attività.

`TASK_INPUT_PARAMS`  
I parametri variano in base al tipo di attività. Tutti i parametri di input sono rappresentati come oggetto JSON. Ad esempio, le chiavi JSON per l’attività `RESTORE_DB` sono le seguenti:   
+ `DBNAME`
+ `RESTORE_TIMESTAMP`
+ `S3_BUCKET_NAME`
+ `S3_PREFIX`

`TASK_OUTPUT`  
Ulteriori informazioni sull'attività. Se si verifica un errore durante il ripristino nativo, questa colonna contiene informazioni sull’errore. 

### Esempi di risposta
<a name="db2-udf-get-task-status-response-examples"></a>

Il seguente esempio di risposta mostra l’esito positivo della creazione di un database denominato `TESTJP`. Per ulteriori informazioni, consulta la stored procedure [rdsadmin.create\$1database](db2-sp-managing-databases.md#db2-sp-create-database).

```
`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`.
```

Il seguente esempio di risposta illustra il motivo per cui l’eliminazione di un database non è riuscita. Per ulteriori informazioni, consulta la stored procedure [rdsadmin.drop\$1database](db2-sp-managing-databases.md#db2-sp-drop-database).

```
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
```

Il seguente esempio di risposta mostra l’esito positivo del ripristino di un database. Per ulteriori informazioni, consulta la stored procedure [rdsadmin.restore\$1database](db2-sp-managing-databases.md#db2-sp-restore-database).

```
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\$1databases
<a name="db2-udf-list-databases"></a>

Restituisce un elenco di tutti i database in esecuzione su un’istanza database RDS per Db2.

### Sintassi
<a name="db2-udf-list-databases-syntax"></a>

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

### Note per l’utilizzo
<a name="db2-udf-list-databases-usage-notes"></a>

Questa funzione definita dall’utente non specifica se i database sono in stato attivato o disattivato. 

Se i database non sono visualizzati nell’elenco, chiama la funzione [rdsadmin.get\$1task\$1status](#db2-udf-get-task-status) definita dall’utente e cerca i messaggi di errore.

### Risposta
<a name="db2-udf-list-databases-response"></a>

La funzione `rdsadmin.list_databases` definita dall’utente restituisce le seguenti colonne: 

`DATABASE_NAME`  
Il nome di un database.

`CREATE_TIME`  
La data e l’ora di creazione del database.

`DATABASE_UNIQUE_ID`  
Il GUID creato da RDS per identificare in modo univoco il database Db2.

`ARCHIVE_LOG_RETENTION_HOUR`  
Il numero di ore della conservazione dei file di log archiviati.

`ARCHIVE_LOG_COPY`  
Indica se la funzionalità è ABILITATA o DISABILITATA per il database.

`ARCHIVE_LOG_LAST_UPLOAD_FILE `  
Indica l'ultimo registro di archivio caricato su S3.

`ARCHIVE_LOG_LAST_UPLOAD_FILE_TIME`  
Indica l'ora in cui il file di registro è stato archiviato.

`ARCHIVE_LOG_COPY_STATUS`  
Visualizza lo stato della copia del registro di archivio.  
CARICAMENTO: indica che i file di registro dell'archivio vengono caricati su S3.  
CONFIGURATION\$1ERROR: indica che c'è un problema di configurazione che richiede la tua attenzione.   
Per visualizzare l'errore dettagliato, consulta RDS Event Messages for you Db Instance. I messaggi relativi agli eventi possono essere visualizzati nella sezione [Visualizzazione degli eventi Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ListEvents.html).

### Esempi di risposta
<a name="db2-udf-list-databases-response-examples"></a>

Il seguente esempio di risposta mostra un elenco di database e l’ora in cui sono stati creati. `rdsadmin` è un database gestito da Amazon RDS e appare sempre nell’output.

```
DATABASE_NAME   CREATE_TIME                DATABASE_UNIQUE_ID                                 ARCHIVE_LOG_RETENTION_HOURS ARCHIVE_LOG_COPY ARCHIVE_LOG_LAST_UPLOAD_FILE ARCHIVE_LOG_LAST_UPLOAD_FILE_TIME ARCHIVE_LOG_COPY_STATUS
--------------- -------------------------- -------------------------------------------------- --------------------------- ---------------- ---------------------------- --------------------------------- ------------------------------
RDSADMIN        2026-01-06-02.03.42.569069 RDSADMIN                                                                     0 DISABLED         -                            -                                 -
FOO             2026-01-06-02.13.42.885650 F0D81C7E-7213-4565-B376-4F33FCF420E3                                         0 ENABLED          S0006536.LOG                 2026-01-28-19.15.10.000000        UPLOADING
CODEP           2026-01-14-19.42.42.508476 106EEF95-6E30-4FFF-85AE-B044352DF095                                         0 DISABLED         -                            -                                 -
...
```

## rdsadmin.list\$1modifiable\$1db\$1params
<a name="db2-udf-list-modi-db-params"></a>

Restituisce un elenco di tutti i parametri di configurazione modificabili del database.

### Sintassi
<a name="db2-udf-list-modi-db-params-syntax"></a>

```
db2 "select * from table(rdsadmin.list_modifiable_db_params())"
```

### Note per l’utilizzo
<a name="db2-udf-list-modi-db-params-usage-notes"></a>

Questa funzione definita dall'utente visualizza un elenco selezionato di parametri modificabili del database. Questi parametri possono essere aggiornati utilizzando la stored procedure. [rdsadmin.update\$1db\$1param](db2-sp-managing-databases.md#db2-sp-update-db-param)

Tutti i parametri del database non inclusi in questo elenco sono soggetti a restrizioni e non possono essere modificati.

### Risposta
<a name="db2-udf-list-modi-db-params-response"></a>

La funzione `rdsadmin.list_modifiable_db_params` definita dall’utente restituisce le seguenti colonne: 

`PARAM_NAME`  
Il nome del parametro che può essere modificato.

`DEFAULT_VALUE`  
Valore predefinito del parametro al momento della creazione del database.

`RESTART_REQUIRED`  
Se è richiesto o meno il riciclo del database.  
 Y = Sì, è necessario riavviare il database.  
 N = No, il riavvio del database non è richiesto.

### Esempi di risposta
<a name="db2-udf-list-modi-db-params-response-examples"></a>

Di seguito è riportato un elenco di esempio (troncato) dell'output previsto.

```
PARAM_NAME             DEFAULT_VALUE RESTART_REQUIRED
---------------------- ------------- ----------------
ACT_SORTMEM_LIMIT      NONE          N
ARCHRETRYDELAY         20            N
AUTHN_CACHE_DURATION   3             N
AUTHN_CACHE_USERS      0             N
AUTO_CG_STATS          OFF           N
...
```