Azure Synapse

Konektor Azure Synapse memungkinkan Anda terhubung ke kumpulan SQL Azure Synapse dan menggunakan SQL untuk mengambil dan memperbarui data Azure Synapse.

Sebelum memulai

Sebelum menggunakan konektor Azure Synapse, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Buat baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor meliputi:

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih Azure Synapse dari daftar drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih Versi konektor dari daftar drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah node maksimum: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    7. Tenant Azure: Properti ini menentukan tenant Microsoft Azure yang digunakan untuk mengakses data.
    8. Database: Properti ini menentukan Nama database Synapse di kumpulan SQL tanpa server atau kumpulan SQL khusus .
    9. Di bagian Tujuan, masukkan properti berikut:
      • Destination Type: Pilih Host Address dari drop-down
      • Host 1: Masukkan endpoint kumpulan SQL
      • Port 1: Masukkan port untuk endpoint sql
      .
    10. Secara opsional, masukkan properti berikut untuk SSL:
      • Aktifkan SSL: Properti kotak centang ini menentukan apakah SSL akan diaktifkan.
      • Trust Store: Properti ini menentukan trust store. Anda dapat memilih tombol pilihan untuk memilih penyimpanan tepercaya dari Koneksi Publik, Pribadi, atau Tidak Aman.
      • Custom Trust Store: Properti ini digunakan untuk memilih rahasia yang berisi trust store kustom dalam format PEM.
      • Sertifikat Klien SSL: Properti ini menentukan sertifikat klien SSL.
      • Kunci Pribadi Klien SSL: Properti ini menentukan kunci pribadi klien SSL dalam format PEM.
      • Frasa Sandi Kunci Sertifikat Klien SSL: Properti ini menentukan frasa sandi kunci pribadi klien SSL.
    11. Atau, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    12. Klik Berikutnya.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Azure Synapse:

      • Sandi Pengguna
      • Azure AD

      2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    2. Klik Berikutnya.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Buat.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Sandi Pengguna
    • Nama Pengguna: Masukkan nama pengguna database.
    • Sandi: Secret Manager Secret yang berisi sandi yang terkait dengan nama pengguna.
  • Azure AD
    • Client ID: Client ID yang digunakan untuk meminta token akses. ID ini dapat ditemukan di ringkasan aplikasi terhubung yang dibuat di portal Azure.
    • Cakupan:Daftar cakupan yang diinginkan, yang dipisahkan koma.
    • Client Secret: Secret Manager Secret yang berisi Kunci Akses Akun.
    • URL otorisasi: URL otorisasi yang Anda buat saat membuat klien OAuth. Masukkan URL dalam format berikut: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Misalnya, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent.

Langkah tambahan setelah pembuatan koneksi

Jika Anda memilih OAuth 2.0 - Authorization code untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:

  1. Di halaman Koneksi, temukan koneksi yang baru dibuat.

    Perhatikan bahwa Status untuk konektor baru akan menjadi Otorisasi diperlukan.

  2. Klik Otorisasi diperlukan.

    Tindakan ini akan menampilkan panel Edit otorisasi.

  3. Salin nilai Redirect URI ke aplikasi eksternal Anda.
  4. Verifikasi detail otorisasi.
  5. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Otorisasi ulang untuk kode otorisasi

Jika Anda menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi apa pun di aplikasi Azure Synapse, Anda harus mengizinkan ulang koneksi Azure Synapse. Untuk memberikan kembali otorisasi koneksi, lakukan langkah-langkah berikut:

  1. Klik koneksi yang diperlukan di halaman Koneksi.

    Tindakan ini akan membuka halaman detail koneksi.

  2. Klik Edit untuk mengedit detail koneksi.
  3. Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.

    Jika diperlukan, lakukan perubahan yang diperlukan.

  4. Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
  5. Klik Edit otorisasi di bagian Autentikasi. Tindakan ini akan menampilkan panel Authorize.
  6. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

  • Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.

    Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:

    Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas utama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Batasan sistem

Konektor Azure Synapse dapat memproses maksimum 4 transaksi per detik, per node, dan membatasi transaksi apa pun yang melebihi batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.

Jenis data yang didukung

Berikut adalah jenis data yang didukung untuk konektor ini:

  • BIGINT
  • BINARY
  • BIT
  • CHAR
  • DATE
  • DATETIME
  • DATETIME2
  • DATETIMEOFFSET
  • DECIMAL
  • FLOAT
  • DECIMAL
  • FLOAT
  • INT
  • UANG
  • NCHAR
  • NVARCHAR
  • NYATA
  • LSEG
  • SMALLDATETIME
  • SMALLINT
  • SMALLMONEY
  • TINYINT
  • UNIQUEIDENTIFIER
  • VARBINARY
  • VARCHAR

Tindakan

Konektor Azure Synapse memungkinkan Anda menjalankan prosedur tersimpan dan kueri SQL kustom dalam format yang didukung oleh Azure Synapse Anda. Untuk menjalankan kueri SQL kustom, konektor menyediakan tindakan Jalankan kueri kustom.

Untuk membuat kueri kustom, ikuti langkah-langkah berikut:

  1. Ikuti petunjuk mendetail untuk menambahkan tugas konektor.
  2. Saat Anda mengonfigurasi tugas konektor, di jenis tindakan yang ingin Anda lakukan, pilih Tindakan.
  3. Dalam daftar Tindakan, pilih Jalankan kueri kustom, lalu klik Selesai.

    Gambar yang menampilkan tindakan execute-custom-query Gambar yang menampilkan tindakan execute-custom-query

  4. Luaskan bagian Input tugas, lalu lakukan hal berikut:
    1. Di kolom Waktu tunggu setelah, masukkan jumlah detik untuk menunggu hingga kueri dieksekusi.

      Nilai default: 180 detik.

    2. Di kolom Jumlah baris maksimum, masukkan jumlah baris maksimum yang akan ditampilkan dari database.

      Nilai default: 25.

    3. Untuk memperbarui kueri kustom, klik Edit Skrip Kustom. Dialog Script editor akan terbuka.

      Gambar yang menampilkan custom-sql-query Gambar yang menampilkan custom-sql-query

    4. Dalam dialog Editor skrip, masukkan kueri SQL, lalu klik Simpan.

      Anda dapat menggunakan tanda tanya (?) dalam pernyataan SQL untuk merepresentasikan satu parameter yang harus ditentukan dalam daftar parameter kueri. Misalnya, kueri SQL berikut memilih semua baris dari tabel Employees yang cocok dengan nilai yang ditentukan untuk kolom LastName: 

      SELECT * FROM Employees where LastName=?

    5. Jika Anda telah menggunakan tanda tanya dalam kueri SQL, Anda harus menambahkan parameter dengan mengklik + Tambahkan Nama Parameter untuk setiap tanda tanya. Saat menjalankan integrasi, parameter ini menggantikan tanda tanya (?) dalam kueri SQL secara berurutan. Misalnya, jika Anda telah menambahkan tiga tanda tanya (?), maka Anda harus menambahkan tiga parameter sesuai urutan.

      gambar yang menampilkan add-query-param gambar yang menampilkan add-query-param

      Untuk menambahkan parameter kueri, lakukan hal berikut:

      1. Dari daftar Jenis, pilih jenis data parameter.
      2. Di kolom Nilai, masukkan nilai parameter.
      3. Untuk menambahkan beberapa parameter, klik + Tambahkan Parameter Kueri.

      6. Tindakan Execute custom query tidak mendukung variabel array.

Contoh operasi entity

Contoh - Mencantumkan data entity

Contoh ini mencantumkan catatan entity Users.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Users dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Di bagian Input Tugas pada tugas Konektor, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

    Misalnya, menyetel klausa filter ke employeeCode='5100' and startDate='2010-01-01 00:00:00', hanya mencantumkan data yang employeeCode-nya adalah 5100 dan startDate-nya adalah 2010-01-01 00.00.00.

Contoh - Mendapatkan satu record dari entity

Contoh ini mengambil data dari entity Users.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih User dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 103032 di kolom Default Value.

    Di sini, 103032 adalah nilai kunci utama entity Users.

Contoh - Menghapus data dari entity

Contoh ini menghapus data dari entity Users.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Users dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 113132 di kolom Default Value.

    Atau, jika entitas memiliki kunci utama komposit, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Contoh - Membuat data dalam entitas

Contoh ini membuat data di entitas Users.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Users dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}

    5. Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembuatan.

Contoh - Memperbarui data dalam entity

Contoh ini memperbarui data dalam entitas Users.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Users dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"country": "IN"
}
  5. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 113132 di kolom Default Value.

    Atau, jika entitas memiliki kunci utama gabungan, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

    6. Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi update.

Menggunakan koneksi Azure Synapse dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Forum Cloud.

Langkah berikutnya