API REST MariaDB SkySQL: Mengubah Kueri SQL menjadi Endpoint

API REST · SkySQL ke titik akhir

Putar SkySQL Kueri SQL ke dalam API REST titik akhir

Simpan kueri di Query Builder, klik Titik akhir baru, dan Anda memiliki URL di api.querystreams.com dengan kunci tersendiri. SQL berjalan hanya baca pada Agen yang sudah ada dengan basis data SkySQL Anda; pemanggil mendapatkan JSON atau CSV dan tidak pernah melihat SQL, skema, atau kata sandi. Tidak perlu hosting, tidak perlu membuka port. Sekitar 90 detik dari kueri yang tersimpan, dan paket Gratis mencakup endpoint pertama Anda.

Sekitar 90 detik dari kueri yang tersimpan. Tidak ada server untuk hosting Kredensial Anda akan tetap bersama Anda. Satu kunci per penelepon, dapat dicabut kapan saja.

Inilah hasil akhirnya

Sebuah URL di api.querystreams.com yang mengembalikan baris-baris kueri SkySQL yang Anda simpan sebagai JSON atau CSV kepada siapa pun yang memegang kunci, diuji dari konsol di portal sebelum Anda membagikannya. Seperti ini:

{
  "kota": "Seattle"
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"city": "Seattle"}'

{
  "kolom": [ { "nama": "ID pelanggan", "jenis": "bilangan bulat" }, { "nama": "nama", "jenis": "rangkaian" }, { "nama": "kota", "jenis": "rangkaian" } ],
  baris: [
    { "ID pelanggan": 1042, "nama": "Pedagang Angin Utara", "kota": "Seattle" },
    { "ID pelanggan": 1057, "nama": "Penyedia Perlengkapan Pegunungan Alpen", "kota": "Denver" },
    { "ID pelanggan": 1063, "nama": "Harbour Foods", "kota": "Halifax" }
  ],
  "meta": { "jumlah_baris": 3, "durasi_agen_ms": 41, "request_id": "req_7Hq2mKd9" }
}

MariaDB SkySQL menyimpan data Anda di cloud, yang dijalankan oleh penyedia layanannya. Jika ada pihak lain yang menginginkan sebagian data tersebut untuk aplikasi, dasbor, atau skrip mereka, solusi yang biasa diberikan akan terlalu rumit: login basis data yang tetap berlaku meskipun proyek sudah selesai, ekspor harian yang sudah usang, atau server API kecil yang harus dijalankan dan diperbarui oleh pihak lain. Query Streams menjadikan endpoint sebagai kueri tersimpan ditambah kunci. Agen yang sudah ada di layanan MariaDB Cloud Anda menjalankan kueri, api.querystreams.com memeriksa kunci dan batas laju permintaan, dan pemanggil mendapatkan baris data. SQL, skema, dan kredensial tidak pernah meninggalkan akun Anda.

Yang Anda butuhkan

Akun Query Streams

Semua paket memiliki REST API. Paket gratis memberi Anda satu endpoint, dua kunci, dan 250 baris per panggilan, yang cukup untuk membuat panduan ini. Daftar di sini. my.querystreams.com.

Agen pada komputer yang selalu aktif, dengan koneksi SkySQL yang ditambahkan.

Yang dibutuhkan hanyalah akses internet.

Kueri yang tersimpan di Query Builder

Endpoint tersebut membungkus tepat satu kueri yang tersimpan. Tulis SELECT, jalankan sekali, lalu simpan. Tambahkan Filter Dinamis (sebuah @variable (dalam klausa WHERE) jika pemanggil harus dapat melakukan filter.

Siapkan dalam empat langkah

1. Simpan kueri

   Di dalam Pembuat Kueri Pilih koneksi SkySQL Anda, tulis pernyataan SELECT yang ingin Anda publikasikan, dan jalankan sekali agar Anda dapat melihat baris-barisnya. Pastikan hanya kolom yang dibutuhkan oleh pemanggil; endpoint akan mengembalikan persis apa yang dikembalikan oleh kueri.

   Permintaan tersimpan · pelanggan

   PILIH ID pelanggan, nama, kota
   DARI pelanggan
   MEMESAN OLEH nama
   BATAS 100;

   Jika penelepon perlu dapat melakukan penyaringan, tambahkan Filter Dinamis, misalnya. DI MANA kota = @kota. Setiap @variable menjadi parameter API pada langkah 3. Klik Simpan dan beri nama pada kueri tersebut; nama itu akan menjadi nama tampilan endpoint.

2. Buat titik akhir

   Membuka API di bilah atas dan klik Titik akhir baruPenyihir itu memiliki empat langkah, Pilih kueri, Konfigurasi, Kunci parameter dan Bagikan. Pada Pilih kueriKlik kueri yang baru saja Anda simpan; kueri yang Agennya sedang offline akan berwarna abu-abu. Klik Berikutnya.

   API Terbuka

   Jalan pintas. Dari Query Builder, Anda dapat langsung menampilkan kueri yang terbuka; wizard kemudian akan dimulai dari Konfigurasi dengan kueri yang sudah dipilih.

3. Konfigurasi dan kunci parameter

   Pada Konfigurasi Pengaturan default sudah tepat untuk endpoint pertama: Nama tampilan diisi dari kueri, Jangka hidup Permanen (pilih) Berakhir untuk saham sementara), Mode respons Statis (satu respons JSON; pilih) Mengalir untuk hasil yang melampaui batas baris statis rencana Anda), Format internal JSON. Mode dan format respons akan tetap sama setelah dibuat, jadi tentukan di sini. Klik Berikutnya.

   Pada Kunci parameter Semua Filter Dinamis dalam kueri akan tercantum. Biarkan filter yang mungkin diatur oleh pengguna sebagai berikut. Dapat dipanggil dan berikan masing-masing Nama string kueri; centang Diperlukan jika panggilan tanpa itu gagal. Tetapkan nilai yang tidak boleh diubah oleh pemanggil. Terkunciatau skenario kencan seperti Awal bulan. Tersembunyi Mempertahankan nilai default kueri dan menolak setiap upaya untuk mengubahnya. Klik Berikutnya.

4. Bagikan dan dapatkan kunci Anda

   Pada Bagikan Anda bisa mengundang Rakyat melalui email atau tambahkan Kunci layanan untuk server atau alat otomatisasi, atau lewati keduanya untuk saat ini. Klik Buat & dapatkan kunci sayaLayar sukses menampilkan URL endpoint dan kunci Anda: string sepanjang 49 karakter yang diawali dengan qsapi_Salinlah. Anda dapat menampilkannya kembali nanti dari endpoint tersebut. Berbagi tab, agar tidak hilang jika Anda menutup layar.

   Klik Mengirim di konsol untuk melakukan panggilan pertama dari portal itu sendiri. Panel respons menunjukkan Status, Waktu dan Ukuran, itu Tubuh Tab tersebut menampilkan JSON, dan panggilan tersebut muncul di Aktivitas tekan tab beberapa detik kemudian.

Lakukan panggilan dari mana saja

Ganti ID endpoint dengan ID Anda dari bilah URL konsol dan qsapi_KUNCI_ANDA dengan kunci Anda. Parameter yang dapat dipanggil dimasukkan ke dalam string kueri pada permintaan GET; di sini kueri yang tersimpan mengekspos kota:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?city=Seattle" \ -H "X-API-Key: qsapi_KUNCI_ANDA"

{
  "kolom": [ { "nama": "ID pelanggan", "jenis": "bilangan bulat" }, { "nama": "nama", "jenis": "rangkaian" }, { "nama": "kota", "jenis": "rangkaian" } ],
  baris: [
    { "ID pelanggan": 1042, "nama": "Pedagang Angin Utara", "kota": "Seattle" },
    { "ID pelanggan": 1057, "nama": "Penyedia Perlengkapan Pegunungan Alpen", "kota": "Denver" },
    { "ID pelanggan": 1063, "nama": "Harbour Foods", "kota": "Halifax" }
  ],
  "meta": { "jumlah_baris": 3, "durasi_agen_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Baris dikembalikan sebagai objek yang dikunci berdasarkan nama kolom, dengan daftar kolom dan sebuah meta Blok yang memberi tahu Anda berapa banyak baris yang ada, apakah hasilnya terpotong, dan ID permintaan yang dapat Anda kutip untuk mendukung permintaan tersebut. Panggilan yang sama seperti POST menempatkan parameter dalam badan JSON, yang merupakan pilihan tepat untuk daftar nilai yang panjang:

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"city": "Seattle"}}'

?format=csv

CSV, bukan JSON, termasuk baris header. Menerima format teks/csv melakukan hal yang sama. Endpoint streaming mengembalikan NDJSON (satu objek JSON per baris) dengan akhiran {"_ringkasan": benar, "jumlah_baris": N} baris; periksa baris terakhir itu.

?sampel=benar

Maksimal lima baris, tidak dikenakan biaya. Cocok untuk memasang kabel pada klien.

kompresi=lz4

Badan rangka LZ4 untuk penelepon bervolume tinggi dengan dekoder; Kode Tab tersebut berisi cuplikan dekoder per bahasa. Kompresi gzip biasa terjadi secara otomatis saat klien Anda mengirimkan data. Accept-Encoding: gzip.

Otorisasi: Bearer qsapi_…

Diterima sebagai alias untuk Kunci API XGunakan dari kode browser.

Di mana colokannya

Apa yang diizinkan oleh rencana tersebut

Setiap panggilan juga memiliki batas waktu kueri tetap 60 detik dan batas respons 8 MiB, dan byte yang dikembalikan akan dihitung terhadap kuota data bulanan paket Anda, kuota yang sama yang digunakan oleh add-in Excel dan Google Sheets. Paket gratis memiliki satu endpoint dan 5 MB per bulan, yang cukup untuk tabel kecil yang dipanggil berkali-kali dalam sehari. Lihat halaman harga. untuk tunjangan berdasarkan rencana.

Menjaganya tetap aman

Ketika sesuatu tidak berfungsi

Setiap badan kesalahan memiliki bentuk {"kesalahan": {"kode": "…", "pesan": "…"}} dan setiap respons membawa sebuah ID Permintaan X-QS Header. Kutip ID saat Anda menghubungi dukungan.

Pertanyaan yang diajukan orang

Panduan terkait

• Hubungkan MariaDB SkySQL ke Claude dengan MCP
• API REST Basis Data: Ubah Kueri SQL Apa Pun Menjadi Titik Akhir
• API REST Microsoft SQL Server
• API REST PostgreSQL
• API REST MySQL
• API REST Snowflake