

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Amazon RDS untuk referensi fungsi yang ditentukan pengguna Db2
<a name="db2-user-defined-functions"></a>

Fungsi yang ditentukan pengguna berikut tersedia untuk instans Amazon RDS DB yang menjalankan mesin 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>

Menghasilkan status tugas.

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

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

Parameter-parameter berikut bersifat opsional. Jika Anda tidak memberikan parameter sama sekali, fungsi buatan pengguna ini akan menghasilkan status semua tugas untuk semua basis data. Amazon RDS mempertahankan riwayat tugas selama 35 hari.

*task\$1id*  
ID tugas yang sedang dijalankan. ID ini dihasilkan saat Anda menjalankan sebuah tugas. Default: `0`. 

*database\$1name*  
Nama basis data yang menjalankan tugas.

*task\$1type*  
Jenis tugas untuk dikueri. Nilai yang valid: `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`.

### Catatan penggunaan
<a name="db2-udf-get-task-status-usage-notes"></a>

Anda dapat menggunakan fungsi yang `rdsadmin.get_task_status` ditentukan pengguna untuk memeriksa status tugas berikut untuk Amazon RDS untuk Db2. Daftar ini tidak lengkap.
+ Membuat, mengubah, atau mengedrop kolam penyangga
+ Membuat, mengubah, atau mengedrop ruang tabel
+ Membuat atau mengedrop basis data
+ Memulihkan cadangan basis data dari Amazon S3
+ Menggulir maju log basis data dari Amazon S3

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

Contoh berikut menampilkan kolom-kolom yang dihasilkan saat `rdsadmin.get_task_status` dipanggil.

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

Contoh berikut memerinci status semua tugas.

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

Contoh berikut memerinci status tugas tertentu.

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

Contoh berikut memerinci status tugas dan basis data tertentu.

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

Contoh berikut memerinci status semua tugas `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'))"
```

Contoh berikut memerinci status semua tugas untuk basis data tertentu. 

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

Contoh berikut menghasilkan nilai-nilai JSON berupa kolom.

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

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

Fungsi buatan pengguna `rdsadmin.get_task_status` menghasilkan kolom-kolom berikut:

`TASK_ID`  
ID tugas.

`TASK_TYPE`  
Bergantung pada parameter-parameter input.  
+ `ADD_GROUPS` – Menambahkan grup.
+ `ADD_USER` – Menambahkan pengguna.
+ `ALTER_BUFFERPOOL` – Mengubah kolam penyangga.
+ `ALTER_TABLESPACE` – Mengubah ruang tabel.
+ `CHANGE_PASSWORD ` – Mengubah kata sandi pengguna.
+ `COMPLETE_ROLLFORWARD` – Menyelesaikan tugas `rdsadmin.rollforward_database` dan mengaktifkan basis data.
+ `CREATE_BUFFERPOOL` – Membuat kolam penyangga.
+ `CREATE_DATABASE` – Membuat basis data.
+ `CREATE_ROLE` – Membuat peran Db2 untuk pengguna.
+ `CREATE_TABLESPACE` – Membuat ruang tabel.
+ `DROP_BUFFERPOOL` – Mengedrop kolam penyangga.
+ `DROP_DATABASE` – Menghapus basis data.
+ `DROP_TABLESPACE` – Mengedrop ruang tabel.
+ `LIST_USERS` – Memerinci semua pengguna.
+ `REMOVE_GROUPS` – Menghapus grup.
+ `REMOVE_USER` – Menghapus pengguna.
+ `RESTORE_DB` – Memulihkan basis data lengkap.
+ `ROLLFORWARD_DB_LOG` – Melakukan tugas `rdsadmin.rollforward_database` pada log basis data.
+ `ROLLFORWARD_STATUS ` – Menghasilkan status tugas `rdsadmin.rollforward_database`.
+ `UPDATE_DB_PARAM` – Memperbarui parameter data.

`DATABASE_NAME`  
Nama basis data yang terkait dengan tugas.

`COMPLETED_WORK_BYTES`  
Jumlah byte yang dipulihkan oleh tugas.

`DURATION_MINS`  
Waktu yang dibutuhkan untuk menyelesaikan tugas. 

`LIFECYCLE`  
Status tugas. Status yang mungkin:  
+ `CREATED` – Setelah tugas diserahkan ke Amazon RDS, Amazon RDS menetapkan statusnya ke `CREATED`.
+ `IN_PROGRESS` – Setelah tugas dimulai, Amazon RDS menetapkan statusnya ke `IN_PROGRESS`. Diperlukan hingga 5 menit agar status berubah dari `CREATED` ke `IN_PROGRESS`.
+ `SUCCESS` – Setelah tugas selesai, Amazon RDS menetapkan statusnya ke `SUCCESS`.
+ `ERROR` – Jika tugas pemulihan gagal, Amazon RDS menetapkan statusnya ke `ERROR`. Lihat informasi yang lebih lengkap tentang kesalahan ini di `TASK_OUPUT`. 

`CREATED_BY`  
`authid` yang membuat perintah.

`CREATED_AT`  
Tanggal dan waktu ketika tugas dibuat.

`LAST_UPDATED_AT`  
Tanggal dan waktu ketika tugas terakhir diperbarui.

`TASK_INPUT_PARAMS`  
Parameter-parameter berbeda-beda berdasarkan jenis tugas. Semua parameter input disajikan berupa objek JSON. Misalnya, kunci JSON untuk tugas `RESTORE_DB` adalah sebagai berikut:   
+ `DBNAME`
+ `RESTORE_TIMESTAMP`
+ `S3_BUCKET_NAME`
+ `S3_PREFIX`

`TASK_OUTPUT`  
Informasi tambahan tentang tugas. Jika terjadi kesalahan selama pemulihan asli, kolom ini mencakup informasi tentang kesalahan itu. 

### Contoh respons
<a name="db2-udf-get-task-status-response-examples"></a>

Contoh respons berikut menunjukkan bahwa basis data bernama `TESTJP` berhasil dibuat. Lihat informasi yang lebih lengkap di prosedur tersimpan [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`.
```

Contoh respons berikut menjelaskan alasan gagalnya pengedropan basis data. Lihat informasi yang lebih lengkap di prosedur tersimpan [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
```

Contoh respon berikut menunjukkan keberhasilan pemulihan database. Lihat informasi yang lebih lengkap di prosedur tersimpan [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>

Mengembalikan daftar semua database berjalan pada RDS untuk contoh Db2 DB.

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

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

### Catatan penggunaan
<a name="db2-udf-list-databases-usage-notes"></a>

Fungsi yang ditentukan pengguna ini tidak menentukan apakah database berada dalam keadaan diaktifkan atau dinonaktifkan. 

Jika Anda tidak melihat database dalam daftar, panggil fungsi yang [rdsadmin.get\$1task\$1status](#db2-udf-get-task-status) ditentukan pengguna dan cari pesan kesalahan.

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

Fungsi buatan pengguna `rdsadmin.list_databases` menghasilkan kolom-kolom berikut: 

`DATABASE_NAME`  
Nama database.

`CREATE_TIME`  
Tanggal dan waktu ketika database dibuat.

`DATABASE_UNIQUE_ID`  
RDS menciptakan GUID untuk mengidentifikasi database Db2 secara unik.

`ARCHIVE_LOG_RETENTION_HOUR`  
Jumlah jam untuk menyimpan file log arsip.

`ARCHIVE_LOG_COPY`  
Menampilkan jika fitur diaktifkan atau DINONAKTIFKAN untuk database.

`ARCHIVE_LOG_LAST_UPLOAD_FILE `  
Menunjukkan log arsip terakhir yang diunggah ke S3.

`ARCHIVE_LOG_LAST_UPLOAD_FILE_TIME`  
Menunjukkan waktu ketika file log diarsipkan.

`ARCHIVE_LOG_COPY_STATUS`  
Menampilkan status salinan log arsip.  
UPLOADING: menunjukkan bahwa file log arsip sedang diunggah ke S3.  
CONFIGURATION\$1ERROR: menunjukkan bahwa ada masalah konfigurasi yang membutuhkan perhatian Anda.   
Untuk melihat kesalahan mendetail, lihat Pesan Acara RDS untuk Instans Db Anda. Pesan Acara dapat dilihat di [Melihat acara Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ListEvents.html).

### Contoh respons
<a name="db2-udf-list-databases-response-examples"></a>

Contoh respon berikut menunjukkan daftar database dan waktu ketika mereka dibuat. `rdsadmin`adalah database yang dikelola Amazon RDS dan selalu muncul di 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>

Mengembalikan daftar semua parameter konfigurasi database dimodifikasi.

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

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

### Catatan penggunaan
<a name="db2-udf-list-modi-db-params-usage-notes"></a>

Fungsi yang ditentukan pengguna ini menampilkan daftar parameter database yang dapat dimodifikasi yang dipilih. Parameter ini dapat diperbarui menggunakan prosedur yang disimpan[rdsadmin.update\$1db\$1param](db2-sp-managing-databases.md#db2-sp-update-db-param).

Parameter database apa pun yang tidak termasuk dalam daftar ini telah dibatasi dan tidak dapat dimodifikasi.

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

Fungsi buatan pengguna `rdsadmin.list_modifiable_db_params` menghasilkan kolom-kolom berikut: 

`PARAM_NAME`  
Nama parameter yang dapat dimodifikasi.

`DEFAULT_VALUE`  
Nilai parameter default pada saat pembuatan database.

`RESTART_REQUIRED`  
Jika daur ulang basis data diperlukan untuk tidak.  
 Y = Ya, database restart diperlukan.  
 N = Tidak, Database restart tidak diperlukan.

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

Berikut ini adalah contoh (terpotong) daftar output yang diharapkan.

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