DataWorks：Manajemen komponen

Langkah 1: Definisikan komponen

Developer dapat menggunakan halaman SQL Script Templates di Data Studio untuk mendefinisikan kode body prosedur beserta parameter input dan output-nya. Dengan menulis proses SQL abstrak, Anda dapat menggunakan parameter input untuk memproses tabel input tertentu dan menghasilkan tabel output bernilai, yang direpresentasikan oleh parameter output. Format parameter input dan output dalam kode adalah @@{parameter_name}.

1. Di area manajemen templat skrip spesifik ruang kerja, klik dan pilih Create SQL Script Template. Anda juga dapat memilih Create Directory terlebih dahulu untuk merencanakan folder templat skrip Anda, lalu klik kanan folder tersebut dan pilih Create SQL Script Template.

   Catatan

   • Komponen yang dibuat oleh anggota ruang kerja ini dikelola di bawah Workspace SQL Script Templates.

   • Anda dapat menemukan komponen yang telah dipublikasikan di bawah Public SQL Script Templates.

2. Anda dapat mengonfigurasi informasi komponen.

   1. Konfigurasikan body prosedur.

      Body prosedur merupakan kode implementasi dari templat skrip. Dengan menulis kode SQL abstrak dan menggunakan format @@{parameter_name}, Anda dapat menyertakan parameter input dan output. Hal ini memungkinkan Anda memproses tabel input tertentu menggunakan parameter input untuk menghasilkan tabel output bernilai. Saat menggunakan templat skrip, Anda hanya perlu mengonfigurasi parameter input dan output yang berbeda agar menghasilkan kode SQL yang benar dan dapat dijalankan.

   2. Konfigurasikan parameter input.

      Di sisi kanan halaman pengeditan komponen, klik Parameter Configuration. Klik ikon di sebelah kanan Input Parameters untuk mendefinisikan parameter input untuk body prosedur. Anda dapat menentukan parameter input sebagai Table atau String.

      Catatan

      Anda juga dapat mengklik Parse I/O Parameters di bagian atas halaman editor templat skrip. Fitur ini secara otomatis mendeteksi parameter input dan output dari kode. Anda kemudian dapat mengonfigurasi parameter tersebut seperti yang dijelaskan dalam tabel berikut.

      Table

      Skenario

      Gunakan tipe ini ketika templat skrip memproses data tabel sumber untuk menghasilkan output dengan kategori tunggal yang konstan.

      Parameter konfigurasi dan deskripsi

      • Parameter utama: Parameter Definition.

      • Deskripsi konfigurasi: Parameter ini mendefinisikan skema tabel input dalam format teks, termasuk nama bidang, tipe data, dan deskripsi. Definisi ini memberi tahu pengguna bahwa saat menggunakan templat skrip, tabel input yang mereka konfigurasikan harus memiliki jumlah bidang yang sama dan tipe data yang kompatibel seperti yang didefinisikan di sini. Hal ini membantu mencegah error waktu proses akibat ketidaksesuaian jumlah bidang atau ketidakcocokan tipe data antara tabel input yang dikonfigurasi dan tabel input yang didefinisikan.

        Catatan

        Definisi ini hanya bersifat referensi. Ini memberikan petunjuk untuk mengonfigurasi parameter input dan tidak memicu pemeriksaan langsung.

      • Contoh:

        Kami menyarankan Anda mendefinisikan parameter dalam format berikut:

        Field1_Name Field1_Type Field1_Comment 
        Field2_Name Field2_Type Field2_Comment 
        ...
        Fieldn_Name Fieldn_Type Fieldn_Comment

        Konfigurasi contoh:

        area_id STRING 'area ID' 
        city_id STRING 'city ID' 
        order_amt DOUBLE 'Jumlah pesanan' 

      String

      Skenario

      Gunakan tipe ini untuk mengontrol nilai parameter input dengan variabel saat memproses data tabel sumber.

      Parameter konfigurasi dan deskripsi

      • Parameter utama: Default Value.

      • Deskripsi konfigurasi: Anda dapat menetapkan nilai default untuk tipe parameter ini. Jika nilai default ditetapkan, nilai tersebut akan digunakan saat templat skrip dijalankan.

      • Contoh:

        • Skenario 1: Tabel output templat skrip harus menampilkan penjualan N kota teratas di setiap wilayah. Anda dapat menetapkan N sebagai parameter input untuk templat skrip dan mengontrol nilai N menggunakan parameter string.

        • Skenario 2: Tabel output templat skrip harus menampilkan total penjualan suatu provinsi. Anda dapat menetapkan parameter string provinsi sebagai parameter input untuk templat skrip. Dengan menentukan provinsi yang berbeda, Anda dapat mengambil data penjualan untuk provinsi yang sesuai.

   3. Konfigurasikan parameter output.

      Definisikan parameter output dari body prosedur, yang merepresentasikan tabel output akhir dari templat skrip. Untuk mempermudah pengguna lain menggunakan templat skrip, Anda dapat menentukan skema tabel output dalam pengaturan parameter output.

      Di sisi kanan halaman pengeditan komponen, klik Parameter Configuration. Klik ikon di sebelah kanan Output Parameters untuk mendefinisikan parameter output untuk body prosedur.

      Catatan

      Anda juga dapat mengklik Parse I/O Parameters di bagian atas halaman editor templat skrip. Fitur ini secara otomatis mendeteksi parameter input dan output dari kode. Anda kemudian dapat mengonfigurasi parameter tersebut seperti yang dijelaskan dalam tabel berikut.

      • Parameter utama: Parameter Definition.

      • Deskripsi konfigurasi: Parameter ini mendefinisikan skema tabel output dalam format teks, termasuk nama bidang, tipe data, dan deskripsi. Definisi ini memberi tahu pengguna bahwa saat menggunakan templat skrip, tabel output yang mereka konfigurasikan harus memiliki jumlah bidang yang sama dan tipe data yang kompatibel seperti yang didefinisikan di sini. Hal ini membantu mencegah error waktu proses akibat ketidaksesuaian jumlah bidang atau ketidakcocokan tipe data antara tabel output yang dikonfigurasi dan tabel output yang didefinisikan.

        Catatan

        Definisi ini hanya bersifat referensi. Ini memberikan petunjuk untuk mengonfigurasi parameter output dan tidak memicu pemeriksaan langsung.

      • Contoh:

        Kami menyarankan Anda mendefinisikan parameter dalam format berikut:

        Field1_Name Field1_Type Field1_Comment 
        Field2_Name Field2_Type Field2_Comment 
        ...
        Fieldn_Name Fieldn_Type Fieldn_Comment

        Anda juga dapat menambahkan bidang untuk hasil agregasi ke definisi parameter output berdasarkan kebutuhan pemrosesan Anda, seperti rank dan total pendapatan. Contohnya:

        area_id STRING 'area ID' 
        city_id STRING 'city ID' 
        order_amt DOUBLE 'Jumlah pesanan'
        rank BIGINT 'rank'

3. Klik Save dan Commit.

   Setelah templat skrip dibuat, Anda dapat mereferensikannya di node templat skrip SQL untuk dengan cepat menghasilkan tabel target untuk bisnis Anda. Untuk informasi selengkapnya, lihat Langkah 2: Referensi templat skrip.

4. (Opsional) Klik Make SQL Script Template Public untuk mempublikasikan templat skrip umum ke seluruh penyewa. Templat tersebut akan ditampilkan di area Public SQL Script Templates. Setelah templat skrip dipublikasikan, semua pengguna dalam penyewa tersebut dapat menggunakannya.

Langkah 2: Mengacu pada Komponen

Anda dapat mereferensikan komponen sebagai berikut.

Operasi upgrade: Developer templat skrip

Developer dapat mengedit kode templat skrip dan pengaturan parameternya sesuai kebutuhan. Setelah menyimpan dan melakukan commit perubahan, templat skrip di-upgrade ke versi baru. Anda dapat melihat detail setiap versi di tab Version.

Meng-upgrade versi yang direferensikan: Pengguna templat skrip

Setelah templat skrip di-upgrade, jika node templat skrip SQL Anda mereferensikannya, Anda dapat memilih apakah akan menggunakan versi terbaru atau tidak.

• Jika tidak perlu menggunakan versi baru, Anda dapat terus menggunakan versi aslinya.

• Jika menggunakan versi baru, pastikan pengaturan parameter versi baru tersebut masih valid untuk node templat skrip SQL Anda. Lakukan penyesuaian berdasarkan deskripsi versi baru tersebut, lalu lakukan commit dan publikasikan node tersebut. Proses commit dan publikasi sama seperti pada node SQL standar.

Contoh skenario upgrade

Seorang developer membuat versi V1 dari templat skrip SQL, yang kemudian digunakan oleh pengguna lain. Kemudian, developer tersebut meng-upgrade templat skrip ke versi V2. Pengguna yang menggunakan templat tersebut menyadari bahwa versi baru, V2, tersedia. Pengguna tersebut membuka templat skrip, melihat detail kedua versi, dan membandingkannya. Setelah menentukan bahwa versi baru memberikan hasil bisnis yang lebih baik, pengguna tersebut memperbarui node untuk menggunakan versi terbaru.

Klon Komponen

Anda dapat menggunakan fitur kloning untuk dengan cepat membuat templat skrip baru dari templat yang sudah ada. Konten yang dikloning mencakup kode templat skrip, konfigurasi parameter, dan parameter skrip dari Run Configuration.

1. Di panel Workspace SQL Script Templates di sebelah kiri, klik kanan nama komponen yang akan dikloning dan pilih Clone dari menu pop-up.

2. Di kotak dialog, ubah Name dan Path komponen (atau pertahankan nilai default), lalu klik OK untuk memulai kloning.

3. Setelah kloning selesai, Anda dapat melihat templat skrip yang baru dihasilkan di bagian Workspace SQL Script Templates.

Manajemen versi

Anda dapat menggunakan fitur manajemen versi untuk mengembalikan templat skrip ke versi historis tertentu. Fitur ini juga memungkinkan Anda melihat dan membandingkan versi untuk membantu menganalisis perbedaan dan melakukan penyesuaian.

1. Di panel Workspace SQL Script Templates di sebelah kiri, klik ganda nama komponen untuk membuka halaman editnya, tempat Anda dapat melihat dan mengelola versinya.

2. Di sisi kanan halaman editor, klik Version. Di halaman Version, Anda dapat melihat dan mengelola Development History dan Deployment History.

   • Lihat versi:

     1. Di tab Development History atau Deployment History, temukan versi templat skrip yang ingin Anda lihat.

     2. Klik View di kolom Actions untuk menuju halaman detail dan melihat kode templat skrip serta konfigurasi penjadwalannya.

   • Bandingkan versi:

     Di tab Development History atau Deployment History, Anda dapat membandingkan versi berbeda dari templat skrip. Contoh berikut menggunakan catatan pengembangan untuk menunjukkan operasi perbandingan.

     • Bandingkan versi di lingkungan pengembangan atau produksi: Di tab Development History, pilih dua versi dan klik tombol Select Versions to Compare di bagian atas. Anda kemudian dapat membandingkan kode templat skrip dan konfigurasi penjadwalan dari versi yang berbeda.

     • Bandingkan lingkungan pengembangan dan produksi:

       1. Di tab Development History, temukan versi tertentu dari templat skrip.

       2. Klik tombol Compare di kolom Actions. Di halaman detail, pilih versi dari Deployment History untuk dibandingkan.

   • Restore versi:

     Anda hanya dapat mengembalikan templat skrip ke versi historis tertentu dari Development History. Di tab Development History, temukan versi target dan klik tombol Restore di kolom Actions. Tindakan ini mengembalikan templat skrip ke versi yang dipilih.