Fitur tinjauan SQL dari Data Management (DMS) mengevaluasi pernyataan SQL yang diajukan dan memberikan rekomendasi untuk mengoptimalkannya. Fitur ini membantu memastikan kualitas kode yang tinggi, seperti kepatuhan terhadap standar pengembangan database dan penggunaan indeks dalam kueri, serta mengurangi risiko serangan injeksi SQL.
Prasyarat
Salah satu jenis database berikut digunakan:
ApsaraDB RDS for MySQL, PolarDB for MySQL, AnalyticDB for MySQL, dan database MySQL yang tidak berada di Alibaba Cloud
ApsaraDB for MariaDB
PolarDB for Xscale
Oracle
PolarDB for PostgreSQL(Compatible with Oracle)
OceanBase
Instansi database dikelola dalam mode Stable Change atau Security Collaboration di DMS. Untuk informasi lebih lanjut, lihat Mode kontrol.
Informasi latar belakang
Selama fase pengembangan proyek, Anda perlu mengeksekusi pernyataan SQL untuk menyisipkan, menghapus, memodifikasi, dan menanyakan data dalam database guna menerapkan logika bisnis dan menampilkan data. Sebelum proyek dipublikasikan, semua pernyataan SQL harus ditinjau untuk memastikan bahwa mereka sesuai dengan standar pengembangan database. Hal ini mencegah masalah yang dapat memengaruhi bisnis. Misalnya, pernyataan CREATE TABLE berikut tidak memiliki kunci utama, komentar tabel, atau komentar bidang:
CREATE TABLE `test_sql_review_table` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`gmt_create` datetime NOT NULL,
`name` varchar(256) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;Jika administrator basis data (DBA) meninjau semua pernyataan SQL secara manual, dibutuhkan banyak sumber daya tenaga kerja, yang mengurangi efisiensi pengembangan.
Untuk mengatasi hal ini, DMS menyediakan fitur SQL review yang mengintegrasikan peninjauan dan optimasi SQL dalam modul aturan keamanan. Anda dapat menggunakan fitur ini untuk meninjau pernyataan SQL dan mendapatkan rekomendasi optimasi. Anda juga dapat menyesuaikan spesifikasi SQL dalam aturan keamanan, seperti menentukan bahwa sebuah tabel harus memiliki kunci utama dan membatasi tipe data serta jumlah kolom kunci utama. Untuk informasi lebih lanjut, lihat Optimasi tinjauan SQL.
Prosedur
- Masuk ke Konsol DMS V5.0.
Geser penunjuk ke ikon
di sudut kiri atas Konsol DMS dan pilih .CatatanJika Anda menggunakan Konsol DMS dalam mode normal, pilih di bilah navigasi atas.
Di sudut kanan atas halaman Tiket Tinjauan SQL, klik SQL Review.
Di halaman Aplikasi Tiket, konfigurasikan parameter yang dijelaskan dalam tabel berikut.
Parameter
Deskripsi
Project Name
Nama proyek.
Database
Database yang ingin Anda kelola.
CatatanAnda dapat memasukkan nama database atau mencari database dengan menambahkan tanda persen (%) sebelum nama database.
Anda harus memiliki izin kueri pada database. Untuk informasi lebih lanjut, lihat Lihat izin yang dimiliki.
Business Background
Tujuan atau objektif dari tinjauan SQL. Anda dapat menentukan parameter ini untuk membantu mengurangi komunikasi yang tidak perlu.
Change Stakeholder
Pemangku kepentingan yang terlibat dalam tinjauan SQL. Semua pemangku kepentingan yang ditentukan dapat melihat detail tiket dan berpartisipasi dalam proses persetujuan. Pengguna lain selain administrator DMS dan DBA tidak diizinkan untuk melihat detail tiket.
File
Metode yang digunakan untuk mengunggah file SQL. Anda dapat menggunakan salah satu metode berikut:
Upload: Anda dapat mengunggah satu atau lebih file SQL.
Enter text: Anda dapat memasukkan pernyataan SQL dalam format
XMLberdasarkan framework iBATIS atau MyBatis, atau memasukkan pernyataan SQL dalam formatTXT.
Untuk informasi lebih lanjut, lihat bagian Contoh File SQL dari topik ini.
Klik Save.
DMS mengurai file SQL dan meninjau setiap pernyataan SQL berdasarkan aturan keamanan yang dikonfigurasi untuk database ini. Setelah tinjauan, DMS memberikan rekomendasi untuk mengoptimalkan pernyataan SQL. Rekomendasi tersebut dikategorikan menjadi empat jenis: Must Improve, Potential Issue, Suggest Improve, dan Index Recommendation. Untuk informasi lebih lanjut, lihat Optimasi tinjauan SQL.
Lihat hasil tinjauan SQL.
Tabel berikut menjelaskan berbagai jenis hasil tinjauan yang disediakan oleh DMS.
State
Deskripsi
Tindakan
Passed
Menunjukkan bahwa pernyataan SQL yang diajukan tidak berisi item yang harus dioptimalkan tetapi mungkin berisi masalah potensial atau item yang dapat dioptimalkan.
Untuk melihat pernyataan SQL dan saran optimasi, klik Details di kolom Operasi.
Untuk memodifikasi pernyataan SQL, klik Adjust SQL di kolom Operasi.
Failed
Menunjukkan bahwa pernyataan SQL yang diajukan berisi item yang harus dioptimalkan.
Untuk melihat saran optimasi, klik Details di kolom Operasi. Untuk memodifikasi pernyataan SQL, klik Adjust SQL di kolom Operasi.
Approve atau Disapprove
Menunjukkan bahwa pernyataan SQL yang diajukan berisi masalah SQL historis tertentu yang tidak dapat atau tidak perlu diselesaikan, selain dari hasil tinjauan SQL yang disediakan oleh fitur tinjauan SQL DMS.
Di kolom Operasi, pilih atau Tinjauan Manual > Disapprove untuk menyetujui atau menolak hasil tinjauan secara manual.
Parsing Exception
Menunjukkan bahwa pernyataan SQL yang diajukan tidak dapat diidentifikasi oleh DMS.
Klik Adjust SQL di kolom Operasi untuk memodifikasi pernyataan SQL. Kemudian, ajukan kembali pernyataan SQL yang telah dimodifikasi untuk pra-pemeriksaan.
Pending Analysis
Menunjukkan bahwa pernyataan SQL yang diajukan sedang menunggu untuk diidentifikasi oleh DMS.
T/A
Di langkah Persetujuan, klik Submit for Approval. Administrator DMS atau DBA akan memeriksa ulang pernyataan SQL.
Setelah tiket disetujui, tiket akan ditutup.
CatatanJika pernyataan SQL yang dimodifikasi masih gagal dalam pemeriksaan atau tidak dapat diuraikan oleh DMS, pesan kesalahan akan dikembalikan setelah Anda klik Submit for Approval di langkah Persetujuan.