Proses mendokumentasikan database SQL Server adalah proses yang lengkap dan berkelanjutan yang harus dimulai selama fase desain dan pengembangan database dan berlanjut selama semua siklus hidup terkait database dengan cara yang memastikan memiliki versi terbaru dari dokumentasi database yang mencerminkan realitas pada setiap titik waktu. Jika dilakukan dengan benar, file dokumentasi database yang dihasilkan akan berisi daftar terbaru dan lengkap untuk objek database dan deskripsi singkat untuk objek database ini.
Proses dokumentasi database SQL Server dapat dilakukan dengan berbagai cara. Anda cukup membuat diagram database yang menunjukkan daftar semua tabel dan kolom database dan memperbarui diagram ini saat ada perubahan yang dilakukan. Tetapi membaca dan memelihara diagram seperti itu bukanlah proses yang mudah untuk database besar dengan lusinan tabel database dengan setiap tabel berisi lusinan kolom.
Mulai dari SQL Server 2005, Microsoft memperkenalkan fitur baru yang disebut Extended Properties, yang disimpan dalam database itu sendiri dan diakses menggunakan objek sistem sys.extended_properties, dan mengembalikan informasi metadata yang terkait dengan database atau objek database yang ditentukan. Mendokumentasikan database SQL Server menggunakan properti yang diperluas bukanlah pilihan terbaik, karena Anda dapat mendokumentasikan satu database pada satu waktu, tidak ada data historis karena properti objek database akan dihapus saat objek ini dihapus, ini bukan proses yang mudah karena membutuhkan keterampilan pengembangan yang baik, membutuhkan usaha yang besar dan memakan waktu yang lama.
Menggunakan Visual Studio
Pengembang yang akrab dengan Microsoft Visual Studio dapat dengan mudah mengambil manfaat dari jenis proyek SQL Server untuk menyambung ke database SQL Server dan memeriksa metadata tentang objek database.
Untuk mencapai itu, buka alat Visual Studio dan buat Proyek Database SQL Server baru dari jendela Proyek Baru, seperti di bawah ini:
Di jendela Proyek Baru, berikan nama unik untuk proyek itu, tempat menyimpan proyek ini, lalu klik OK untuk membuat Proyek Database SQL Server. Ketika proyek dibuat, klik pada properti proyek dan konfigurasikan nilai Platform Target dengan versi SQL Server dari database target, seperti yang ditunjukkan di bawah ini:
Untuk terhubung ke database tertentu, klik kanan proyek yang dibuat dan pilih Import -> Database option sebagai berikut:
Dari jendela Impor Database, pilih koneksi dari daftar koneksi yang disimpan sebelumnya atau berikan nama server, kredensial yang diautentikasi, dan nama database untuk terhubung ke database yang akan didokumentasikan, sebagai berikut:
Saat Anda terhubung pada tombol Connect, alat akan mulai mengumpulkan informasi metadata tentang semua objek database, seperti yang ditunjukkan di bawah ini:
Setelah mengumpulkan dan mengimpor semua informasi database, objek database yang dipilih akan ditampilkan di explorer solusi, dikategorikan per skema, sebagai berikut:
Untuk melihat informasi metadata tentang objek database apa pun, perluas skema dari penjelajah solusi dan klik objek itu dan jendela baru akan terbuka yang menampilkan semua deskripsi untuk objek yang dipilih, dengan skrip T-SQL untuk membuat objek tertentu, seperti yang ditunjukkan di bawah ini:
Ini juga memberi Anda kemampuan untuk menampilkan kolom Deskripsi untuk setiap objek database, dengan mengklik kanan pada ruang kosong di samping tabel yang dipilih dan memilih opsi Deskripsi. Sebuah kolom baru akan ditampilkan yang menunjukkan deskripsi untuk setiap kolom, dengan kemampuan untuk mengedit deskripsi, seperti yang ditunjukkan di bawah ini:
Meskipun terlalu mudah untuk mendokumentasikan database Anda menggunakan Visual Studio, itu tidak menyediakan tempat terpusat untuk memeriksa beberapa objek database, memberikan informasi tentang database tunggal per setiap proyek dan tidak dapat diekspor ke format yang mudah digunakan atau dicetak!
Menggunakan dbForge Docuenter untuk SQL Server
Untuk menghemat waktu dan tenaga Anda serta memperbarui dokumentasi database Anda, sebaiknya gunakan alat pihak ketiga yang mempermudah proses dokumentasi. dbForge Docuenter untuk SQL Server adalah alat dokumentasi database yang dapat dengan mudah dihubungkan ke database Anda dan menghasilkan dokumentasi semua objek database SQL Server dalam beberapa klik.
dbForge Documenter untuk SQL Server memberi kami berbagai template gaya dan opsi yang membantu dalam menyesuaikan dokumentasi yang dihasilkan untuk memenuhi kebutuhan Anda sendiri. Dalam beberapa detik konfigurasi, dbForge Docuenter untuk SQL Server mengekstrak semua informasi dan detail ekstensif tentang database yang dipilih, serta dependensi antar-objek dan skrip T-SQL DDL untuk membuat objek ini, dengan kemampuan untuk mengekspor dokumentasi dalam HTML yang dapat dicari , PDF, dan format file penurunan harga. Format HTML membantu dalam mempublikasikan database di web, dan format PDF cocok untuk didistribusikan ke sistem lain dan dibagikan ke perangkat lain. dbForge Docuenter untuk SQL Server juga dapat diakses untuk mendokumentasikan database secara langsung melalui SQL Server Management Studio karena terintegrasi dengan SSMS.
dbForge Documenter untuk SQL Server dapat diunduh dari pusat unduhan Devart dan diinstal ke server Anda dengan melalui panduan instalasi langsung, seperti di bawah ini:
Ketika Anda mengklik tombol Instal untuk memulai proses instalasi, Anda akan diminta untuk menentukan jalur instalasi untuk alat, jika Anda berhasil membuat ikon desktop untuk alat untuk mengaksesnya lebih cepat, versi SQL Server Management Studio ke memiliki alat ini sebagai add-in di atasnya, ekstensi file yang akan dikaitkan dengan alat dbForge Documenter untuk SQL Server dan akhirnya Anda akan diminta untuk menentukan mode pengoptimalan startup untuk alat tersebut. Setelah itu, proses instalasi akan dimulai, dengan bilah kemajuan yang berguna yang menunjukkan apa yang sedang diinstal sekarang, seperti yang ditunjukkan di bawah ini:
Ketika proses instalasi berhasil diselesaikan, wizard akan memberi tahu Anda dan memberi Anda opsi untuk meluncurkan alat secara langsung, sebagai berikut:
Tampilan pertama dari dbForge Docuenter untuk SQL Server akan mirip dengan jendela di bawah ini. Untuk membuat dokumentasi untuk database Anda menggunakan dbForge Documenter untuk SQL Server, klik pada jendela Dokumentasi Baru dari halaman selamat datang, seperti di bawah ini:
Di jendela dokumentasi yang terbuka, klik Add Connection untuk memilih koneksi yang sudah ada atau menambahkan koneksi baru, dengan memberikan nama server, kredensial yang valid, dan nama database untuk terhubung, menggunakan halaman ramah di bawah ini:
Setelah berhasil tersambung ke database, dbForge Docuenter untuk SQL Server akan mencantumkan semua database dan objek database di bawah contoh SQL Server yang terhubung. Pada awalnya, ini memberi Anda opsi untuk memberikan nama dan deskripsi unik untuk dokumentasi yang akan dibuat, selain logo, nama, dan tanggal Anda sendiri yang akan ditampilkan dalam dokumentasi tersebut, seperti yang ditunjukkan di bawah ini:
Untuk mendokumentasikan database atau objek database tertentu, periksa nama database dari daftar database, tinjau dan sesuaikan berbagai properti dan opsi database untuk disertakan dalam dokumentasi, tetapi aktifkan atau nonaktifkan tombol sertakan di samping setiap properti dan opsi, seperti yang ditunjukkan di bawah ini:
Setelah menyesuaikan apa yang akan disertakan dalam dokumentasi Anda, klik opsi Generate untuk membuat dokumentasi database, berdasarkan pilihan Anda, sebagai berikut:
Di jendela Generate Documentation, tentukan format dokumentasi yang dihasilkan dan jalur serta karakteristik nama file yang dihasilkan, seperti yang ditunjukkan di bawah ini:
Jika Anda mengklik tombol Hasilkan, proses pembuatan dokumentasi akan dimulai, dengan daftar periksa yang mudah digunakan dan bilah kemajuan untuk menunjukkan status proses pembuatan saat ini, seperti di bawah ini:
Ketika proses pembuatan dokumentasi berhasil diselesaikan, dbForge Documenter untuk SQL Server akan memberi tahu Anda dengan hasil akhir, seperti di bawah ini:
Menelusuri jalur tempat file disimpan, Anda akan melihat bahwa dokumentasi database dibuat di bawah jalur tersebut dalam format PDF, seperti yang ditunjukkan di bawah ini:
Laporan akan dibuka juga di alat dbForge Docuenter untuk SQL Server, menampilkan deskripsi untuk database, daftar semua objek dan file database, serta properti dan opsi untuk database yang dipilih, seperti yang ditunjukkan di bawah ini:
dbForge Documenter untuk SQL Server juga memberi Anda kemampuan untuk menyelami secara mendalam setiap objek database. Misalnya, klik hyperlink Tabel, pilih tabel yang Anda minati dan informasi lengkap tentang tabel yang dipilih akan ditampilkan dalam laporan, seperti yang ditunjukkan di bawah ini:
Jelas dari contoh di bawah ini, bagaimana kita dapat menggunakan dbForge Docuenter untuk alat pihak ke-3 SQL Server dalam beberapa klik untuk menghasilkan dokumentasi yang dapat disesuaikan untuk database Anda, yang dapat digunakan untuk berbagai tujuan. Pergi dan coba dokumentasikan database Anda menggunakan dbForge Docuenter untuk SQL Server!
