Menghubungkan ke cluster Aurora DSQL dengan konektor Ruby - Amazon Aurora DSQL

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

Menghubungkan ke cluster Aurora DSQL dengan konektor Ruby

Konektor Aurora DSQL untuk Ruby adalah konektor Ruby yang dibangun di atas pg yang mengintegrasikan otentikasi IAM untuk menghubungkan aplikasi Ruby ke cluster Amazon Aurora DSQL.

Konektor menangani pembuatan token, konfigurasi SSL, dan penyatuan koneksi sehingga Anda dapat fokus pada logika aplikasi Anda.

Tentang konektor

Amazon Aurora DSQL memerlukan otentikasi IAM dengan token terbatas waktu yang tidak didukung oleh driver Ruby PostgreSQL yang ada. Konektor Aurora DSQL untuk Ruby menambahkan lapisan otentikasi di atas permata pg yang menangani pembuatan token IAM, memungkinkan Anda untuk terhubung ke Aurora DSQL tanpa mengubah alur kerja pg yang ada.

Apa itu otentikasi Aurora DSQL?

Dalam Aurora DSQL, otentikasi melibatkan:

  • Otentikasi IAM: Semua koneksi menggunakan otentikasi berbasis IAM dengan token terbatas waktu

  • Generasi Token: Konektor menghasilkan token otentikasi menggunakan AWS kredensil, dan token ini memiliki masa pakai yang dapat dikonfigurasi

Konektor Aurora DSQL untuk Ruby memahami persyaratan ini dan secara otomatis menghasilkan token otentikasi IAM saat membuat koneksi.

Fitur

  • Otentikasi IAM otomatis - Menangani pembuatan dan penyegaran token Aurora DSQL

  • Dibangun di pg - Membungkus permata PostgreSQL populer untuk Ruby

  • Integrasi mulus - Bekerja dengan alur kerja pg gem yang ada

  • Penggabungan koneksi - Dukungan bawaan melalui connection_pool permata dengan penegakan max_lifetime

  • Deteksi otomatis wilayah - Ekstrak AWS wilayah dari nama host cluster Aurora DSQL

  • AWS dukungan kredensil - Mendukung AWS profil dan penyedia kredensil khusus

  • Coba lagi OCC - Coba lagi kontrol konkurensi optimis dengan backoff eksponensial

Contoh aplikasi

Untuk contoh lengkap, lihat contoh aplikasi di GitHub.

Panduan memulai cepat

Persyaratan

  • Ruby 3.1 atau yang lebih baru

  • Akses ke cluster Aurora DSQL

  • AWS kredensyal yang dikonfigurasi (melalui AWS CLI, variabel lingkungan, atau peran IAM)

Penginstalan

Tambahkan ke Gemfile Anda:

gem "aurora-dsql-ruby-pg"

Atau instal langsung:

gem install aurora-dsql-ruby-pg

Penggunaan

Koneksi kolam renang

require "aurora_dsql_pg" # Create a connection pool with OCC retry enabled pool = AuroraDsql::Pg.create_pool( host: "your-cluster.dsql.us-east-1.on.aws", occ_max_retries: 3 ) # Read pool.with do |conn| result = conn.exec("SELECT 'Hello, DSQL!'") puts result[0]["?column?"] end # Write — you must wrap writes in a transaction pool.with do |conn| conn.transaction do conn.exec_params("INSERT INTO users (id, name) VALUES (gen_random_uuid(), $1)", ["Alice"]) end end pool.shutdown

Koneksi tunggal

Untuk skrip sederhana atau saat penyatuan koneksi tidak diperlukan:

conn = AuroraDsql::Pg.connect(host: "your-cluster.dsql.us-east-1.on.aws") conn.exec("SELECT 1") conn.close

Penggunaan lanjutan

Konfigurasi host

Konektor mendukung titik akhir cluster penuh (wilayah terdeteksi secara otomatis) dan cluster IDs (wilayah diperlukan):

# Full endpoint (region auto-detected) pool = AuroraDsql::Pg.create_pool( host: "your-cluster.dsql.us-east-1.on.aws" ) # Cluster ID (region required) pool = AuroraDsql::Pg.create_pool( host: "your-cluster-id", region: "us-east-1" )

AWS profil

Tentukan AWS profil untuk kredensyal:

pool = AuroraDsql::Pg.create_pool( host: "your-cluster.dsql.us-east-1.on.aws", profile: "production" )

Format string koneksi

Konektor mendukung format string koneksi PostgreSQL:

postgres://[user@]host[:port]/[database][?param=value&...] postgresql://[user@]host[:port]/[database][?param=value&...]

Parameter kueri yang didukung:region,profile,tokenDurationSecs.

# Full endpoint with profile pool = AuroraDsql::Pg.create_pool( "postgres://admin@cluster.dsql.us-east-1.on.aws/postgres?profile=dev" )

Coba lagi OCC

Aurora DSQL menggunakan kontrol konkurensi optimis (OCC). Ketika dua transaksi memodifikasi data yang sama, yang pertama melakukan kemenangan dan yang kedua menerima kesalahan OCC.

Coba lagi OCC adalah opt-in. Setel occ_max_retries saat membuat kumpulan untuk mengaktifkan percobaan ulang otomatis dengan backoff eksponensial dan jitter pada: pool.with

pool = AuroraDsql::Pg.create_pool( host: "your-cluster.dsql.us-east-1.on.aws", occ_max_retries: 3 ) pool.with do |conn| conn.transaction do conn.exec_params("UPDATE accounts SET balance = balance - $1 WHERE id = $2", [100, from_id]) conn.exec_params("UPDATE accounts SET balance = balance + $1 WHERE id = $2", [100, to_id]) end end
Awas

pool.withTIDAK secara otomatis membungkus blok Anda dalam transaksi. Anda harus menelepon conn.transaction diri Anda sendiri untuk operasi menulis. Pada konflik OCC konektor mengeksekusi ulang seluruh blok, sehingga seharusnya hanya berisi operasi database dan aman untuk dicoba lagi.

Untuk melewati percobaan ulang pada panggilan individual, teruskanretry_occ: false:

pool.with(retry_occ: false) do |conn| conn.exec("SELECT 1") end

Opsi konfigurasi

Bidang Tipe Default Deskripsi
host String (wajib) Titik akhir cluster atau ID cluster
region String (terdeteksi otomatis) AWS wilayah; diperlukan jika host adalah ID cluster
user String “admin” Pengguna basis data
basis data String “postgres” Nama basis data
port Bilangan Bulat 5432 Port basis data
profile String kosong AWS nama profil untuk kredensyal
token_duration Bilangan Bulat 900 (15 menit) Durasi validitas token dalam hitungan detik (maks diperbolehkan: 1 minggu, default: 15 menit)
credentials_provider Aws: :Kredensyal kosong Penyedia kredensyal khusus
max_seumur hidup Bilangan Bulat 3300 (55 menit) Masa pakai koneksi maksimum dalam hitungan detik
application_name String kosong Awalan ORM untuk application_name
logger Pencatat kosong Logger untuk peringatan coba lagi OCC
occ_max_mencoba lagi Bilangan Bulat nil (dinonaktifkan) Max OCC mencoba ulangpool.with; memungkinkan coba lagi saat disetel

create_pooljuga menerima pool: kata kunci dengan hash opsi yang Anda berikan langsung ke. ConnectionPool.new Jika Anda menghilangkanpool:, konektor default ke. {size: 5, timeout: 5} Kunci yang Anda berikan hanya mengganti default tertentu tersebut.

pool = AuroraDsql::Pg.create_pool( host: "your-cluster.dsql.us-east-1.on.aws", pool: { size: 10, timeout: 10 } )

Autentikasi

Konektor secara otomatis menangani otentikasi Aurora DSQL dengan menghasilkan token menggunakan kredensil. AWS Jika Anda tidak menyediakan AWS wilayah, konektor menguraikannya dari nama host.

Untuk informasi lebih lanjut tentang otentikasi di Aurora DSQL, lihat. Otentikasi dan otorisasi untuk Aurora DSQL

Admin vs pengguna biasa

  • Pengguna bernama “admin” secara otomatis menggunakan token otentikasi admin

  • Semua pengguna lain menggunakan token otentikasi reguler

  • Konektor menghasilkan token secara dinamis untuk setiap koneksi