Lewati ke konten utama
Halaman terjemahan

Halaman ini diterjemahkan dari bahasa Inggris dengan bantuan AI. Jika keduanya berbeda, versi bahasa Inggris menjadi acuannya.

Flag global

Flag global menentukan perilaku program saat runtime untuk aplikasi StackQL; flag ini ditetapkan di baris perintah saat aplikasi StackQL dijalankan (dalam mode interaktif/shell atau mode exec non-interaktif) atau diambil dari file inisialisasi StackQL (.stackqlrc). Flag yang tersedia meliputi:

FlagTipe dataDeskripsiDefault
--access.configstringKonfigurasi akses pemanggil, objek pembungkus JSON {"path": "/path/to/access.json"} (jalur file biasa juga diterima). Mengaktifkan manajemen akses: pemanggil diautentikasi dengan JWT, token bearer statis, TLS mutual, atau identitas OS lokal, dan pernyataan diotorisasi berdasarkan aturan kebijakan. Kredensial token lokal dibaca dari STACKQL_CALLER_TOKEN. Tersedia mulai StackQL v1.0.
--acidstringString JSON / YAML yang merepresentasikan konfigurasi ACID{}
--allow-persistent-secretsflagMengizinkan sesi memilih penyimpanan rahasia OS persisten (macOS Keychain, Linux Secret Service, atau Windows Credential Manager) dengan SET "$.secret_store". Penyimpanan berbasis file datar tetap ditolak meskipun flag ini digunakan. Lihat Sesi provider dan rahasia. Tersedia mulai StackQL v1.0.false
--allow-secret-dereferenceflagMengizinkan nilai rahasia dan kredensial didereferensi dalam ekspresi SQL ("$secrets.name", "$auth.provider.field"), dengan konsekuensi nilai tersebut dapat masuk ke hasil, log, dan artefak kueri yang disimpan. Tidak diperlukan untuk autentikasi provider biasa. Lihat Nilai rahasia di SQL. Tersedia mulai StackQL v1.0.false
--apirequesttimeoutintegerBatas waktu permintaan API dalam detik, 0 berarti tanpa batas waktu45
--approotstringJalur root konfigurasi dan cache aplikasi{cwd}/.stackql
--approotfilemodeuint32Mode file konfigurasi dan cache aplikasi493
--authstringPasangan kunci-nilai konteks auth dalam bentuk json
--cachekeycountintegerJumlah kunci awal cache100
--configfilestringJalur lengkap file konfigurasi{cwd}/.stackqlrc
--cpuprofilestringFile cpuprofile, tidak ada jika kosongnull
--dataflow.dependency.maxintKedalaman maksimum dependensi dataflow untuk kueri tertentu50
--dataflow.components.maxintJumlah maksimum komponen dataflow yang terhubung lemah untuk kueri tertentu50
--dbInternalstringString JSON / YAML untuk mengonfigurasi penanganan kueri pemeliharaan DBMS{}
-d, --delimiterstringPembatas untuk output csv. Hanya satu karakter. Diabaikan untuk semua output selain csv,
--dryrunflagFlag dryrun; hanya menjalankan praprosesor, output hasil template akan dikembalikanfalse
--env.filestringFile opsional bergaya dotenv yang dimuat ke lingkungan proses saat startup (semua perintah); alat MCP reload_credentials memuatnya ulang sesuai permintaan. File yang tidak ada ditoleransi; kunci dengan nilai kosong dilewati; variabel yang sudah ada diganti. Tidak dimuat dari .stackqlrc. Tersedia di rilis StackQL setelah v0.10.542.null
--execution.concurrency.limitintBatas konkurensi untuk eksekusi kueri1
--export.aliasstringPrefiks alias ekspor (namespace atau skema)
--gcstringString JSON / YAML yang merepresentasikan konfigurasi GC{}
-H, --hideheadersflagMenonaktifkan header kolom, hanya valid dengan --output csv atau --output textfalse
--http.log.enabledflagMenampilkan info permintaan http di terminalfalse
--http.proxy.hoststringHost proxy (kosongkan jika tanpa proxy)null
--http.proxy.passwordstringKata sandi proxynull
--http.proxy.portintegerPort proxy, angka apa pun yang kurang dari atau sama dengan 0 akan menghasilkan port default untuk skema tertentu (misalnya http -> 80)-1
--http.proxy.schemestringSkema proxy, http atau httpshttp
--http.proxy.userstringPengguna proxynull
--http.response.maxResultsintegerJumlah hasil maksimum per permintaan http, angka apa pun yang kurang dari atau sama dengan 0 berarti tanpa batasan-1
--http.response.pageLimitintegerJumlah halaman hasil maksimum yang akan dikembalikan per sumber daya, angka apa pun yang kurang dari atau sama dengan 0 berarti tanpa batasan20
--indirect.depth.maxintegerKedalaman maksimum untuk kueri tidak langsung: tampilan dan subkueri5
-i, --infilestringFile input (file IQL) tempat kueri dibaca{stdin}
-q, --iqldatastringFile konteks (data) untuk penggunaan template (file json atau jsonnet)
--loglevelstringLevel log, harus salah satu dari fatalfatal
--mcp.configstringObjek konfigurasi JSON / YAML untuk server MCP (stackql mcp dan stackql srv){}
--mcp.log.formatstringPengodean log audit MCP, jsonl atau otel (catatan log OTLP/JSON); mengganti server.audit.format di --mcp.config. Lihat Format log. Tersedia mulai StackQL v0.11.660.jsonl
--mcp.protocol.versionstringRevisi protokol MCP terbaru yang dinyatakan, auto, 2026-07-28 (hanya tanpa sesi), atau revisi yang lebih lama seperti 2025-11-25; mengganti server.protocol_version di --mcp.config. Lihat Mengunci revisi. Tersedia mulai StackQL v0.12.732.auto
--mcp.server.typestringTipe server MCP, salah satu dari reverse_proxy. Lihat Tipe server MCP.http
--metadatattlintegerTTL untuk dokumen metadata dalam cache, dalam detik3600
--namespacesstringString JSON / YAML yang merepresentasikan namespace untuk cache, tampilan, dan sebagainya{}
--offlineflagBekerja secara offline menggunakan data cachefalse
-f, --outfilestringFile output tempat hasil ditulis{stdout}
-o, --outputstringFormat output, harus salah satu dari otel (ndjson diterima sebagai alias untuk jsonl). otel menghasilkan catatan log OpenTelemetry, lihat Mode output; tersedia mulai StackQL v0.11.660. Dengan exporter yang dikonfigurasi di --otel.config, catatan otel juga dikirim ke endpoint tersebuttable
--otel.configstringString JSON / YAML yang mengonfigurasi format output otel; exporter.endpoint, exporter.headers, exporter.timeout_ms, dan exporter.batch_size mengirim catatan ke endpoint log OTLP/HTTP, lihat Mengirim langsung ke endpoint OTLP. Tersedia mulai StackQL v0.12.732{}
--previewstringString JSON yang mengaktifkan fungsionalitas pratinjau. {"unstable": true} mengekspos relasi stackql_unstable_<provider>.<service>.<resource> berbasis dokumen, yang diselesaikan dan dijalankan oleh omnisdk langsung dari dokumen provider dengan baris yang dialirkan segera setelah dihasilkan; kunci lainnya (batchSize, flushInterval, endpoint, insecureSkipTLSVerify) menyesuaikan backend tersebut. Fungsionalitas pratinjau tidak stabil: perilaku, sintaksis, dan output dapat berubah atau rusak di antara rilis tanpa pemberitahuan, jadi jangan mengandalkannya di lingkungan produksi. Mulai v1.0, aktivasi eksplisit yang sama mengekspos relasi stackql_preview.iac.run dan stackql_preview.iac.destroy, yang menerapkan dan menghapus kumpulan sumber daya yang dideklarasikan melalui omnisdk dengan status yang disimpan di bawah root aplikasi. Lihat Fungsionalitas pratinjau{}
--querycachesizeintegerUkuran cache LRU untuk rencana kueri, dalam jumlah entri10000
--registrystringString JSON / YAML yang mengonfigurasi lokasi registri provider dan verifikasi tanda tangan dokumen providerlihat --registry
--sessionstringString JSON / YAML yang merepresentasikan konfigurasi sesi{}
--sqlBackendstringString JSON / YAML yang merepresentasikan konfigurasi sistem backend SQLlihat --sqlBackend
--store.txnstringString JSON / YAML yang merepresentasikan konfigurasi penyimpanan Txn{}
--tls.CABundlestringJalur ke bundle CA; jika tidak ditentukan, default sistem akan digunakan
--tls.allowInsecureflagMengizinkan kepercayaan terhadap sertifikat yang tidak aman (tidak disarankan)
--varstringVariabel eksternal yang diberikan sebagai pasangan kunci/nilai untuk dimasukkan ke kueri StackQL melalui file data jsonnet
-v, --verboseflagOutput verbosefalse
-h, --helpBantuan sesuai konteks untuk stackql
--versionMenampilkan versi program StackQL

--registry​

Flag --registry mengonfigurasi dari mana dokumen provider dibaca dan apakah tanda tangannya diverifikasi. Nilainya berupa string JSON dengan kunci berikut:

KunciDeskripsiDefault
urlURL registri. Registri provider StackQL publik digunakan jika tidak ditentukan.registri publik
localDocRootDirektori lokal yang berisi dokumen provider, yang dibaca sebagai pengganti pengunduhan dari registri. Digunakan saat mengembangkan provider.
srcPrefixPrefiks jalur di bawah root registri tempat dokumen sumber provider berada.src
verifyConfig.nopVerifytrue melewati verifikasi tanda tangan. Tetapkan ke false untuk mewajibkan tanda tangan ML-DSA-65 (FIPS 204) tersemat pada setiap dokumen provider dan layanan yang dibaca, termasuk relasi pratinjau berbasis dokumen.true
verifyConfig.publicKeysObjek JSON yang memetakan ID kunci ke kunci publik ML-DSA-65 yang dikodekan hex, untuk registri privat. Objek ini menggantikan kunci produksi tersemat; objek kosong yang eksplisit merupakan error.kunci tersemat

Contoh: mewajibkan dokumen provider yang ditandatangani​

Mengaktifkan verifikasi untuk setiap dokumen provider dan layanan yang dibaca dari registri publik, yang diperiksa terhadap kunci produksi tersemat:

stackql --registry '{"verifyConfig": {"nopVerify": false}}' shell

Contoh: membaca dokumen tanpa tanda tangan dari direktori lokal​

Mengarahkan registri ke direktori berisi dokumen provider yang sedang dikembangkan. Dokumen tersebut tidak ditandatangani, sehingga verifikasi tetap nonaktif:

stackql --registry '{"localDocRoot": "/path/to/provider-dev/openapi", "verifyConfig": {"nopVerify": true}}' shell
catatan

Verifikasi tanda tangan tersedia mulai StackQL v1.0 dan nonaktif secara default. Tanda tangan mencakup byte YAML yang persis dari sebuah dokumen, sehingga setiap pengeditan, termasuk perubahan format atau baris baru, membuat tanda tangan tidak valid; tandatangani ulang dengan alat pqsig sign-doc milik registri. Dokumen pengembangan lokal yang tidak ditandatangani harus tetap menggunakan nopVerify: true. Opsi sertifikat sebelumnya dan file sidecar .sig tidak lagi digunakan, dan arsip yang dipublikasikan hanya dengan sidecar harus dipublikasikan ulang sebelum digunakan dengan verifikasi. Verifikasi mengautentikasi dokumen saat dokumen dibaca; pengunduhan dan ekstraksi arsip tidak tercakup.

--sqlBackend​

Flag --sqlBackend mengonfigurasi backend SQL eksternal untuk StackQL, sehingga Anda dapat menggunakan mesin database eksternal (seperti PostgreSQL) sebagai pengganti mesin SQL tersemat default. Ini berguna untuk memanfaatkan database eksternal untuk pemrosesan kueri, penyimpanan persisten, atau integrasi dengan infrastruktur database yang sudah ada.

Nilainya berupa string JSON dengan kunci berikut:

KunciDeskripsiContoh nilai
dbEngineTipe mesin databasepostgres_tcp
sqlDialectDialek SQL yang digunakanpostgres
dsnNama sumber data (string koneksi) untuk databaseLihat contoh di bawah

Contoh: menggunakan backend PostgreSQL​

./stackql \
--sqlBackend='{"dbEngine": "postgres_tcp", "sqlDialect": "postgres", "dsn": "postgres://user:password@hostname:port/dbname?sslmode=require"}' \
shell

Contoh: menggunakan antarmuka PostgreSQL Databricks​

Databricks menyediakan antarmuka yang kompatibel dengan PostgreSQL yang dapat digunakan sebagai backend SQL StackQL. DSN menggunakan format string koneksi PostgreSQL standar dengan kredensial Databricks Anda:

./stackql \
--sqlBackend='{"dbEngine": "postgres_tcp", "sqlDialect": "postgres", "dsn": "postgres://user%40domain.com:your-access-token@your-databricks-host.cloud.databricks.com/databricks_postgres?sslmode=require"}' \
shell

catatan

Karakter khusus dalam nama pengguna atau kata sandi (seperti @) harus dikodekan URL di DSN (misalnya, @ menjadi %40).