Lindorm-cli adalah antarmuka baris perintah (CLI) ringan yang disediakan oleh Lindorm untuk menghubungkan dan mengelola database Lindorm. Gunakan Lindorm-cli untuk menjalankan operasi SQL dasar seperti membuat tabel, mengkueri data, menulis data, dan mengekspor data. Topik ini menjelaskan cara menghubungkan ke dan menggunakan mesin tabel lebar Lindorm dengan Lindorm-cli.
Prasyarat
Kami mendefinisikan lingkungan tempat Anda menjalankan lindorm-cli sebagai lingkungan client. Sebelum menggunakan lindorm-cli untuk mengakses mesin tabel lebar Lindorm, pastikan hal-hal berikut:
-
Tambahkan alamat IP client ke daftar putih Lindorm. Untuk informasi selengkapnya, lihat Konfigurasi daftar putih.
-
Tentukan jenis jaringan antara lingkungan client dan Lindorm.
Jenis jaringan berikut didukung saat menghubungkan ke mesin tabel lebar dengan lindorm-cli:
Jenis jaringan
Deskripsi
Virtual private cloud (VPC) (disarankan)
Virtual private cloud (VPC) adalah jaringan pribadi Anda di cloud. VPC yang berbeda diisolasi secara logis pada layer 2, sehingga memberikan keamanan tinggi. Saat Anda menerapkan lindorm-cli pada Instance ECS, menghubungkan ke mesin tabel lebar Lindorm melalui VPC memberikan keamanan lebih tinggi dan latensi jaringan lebih rendah.
Jaringan publik
Jaringan publik mengacu pada Internet. Saat Anda perlu menguji atau mengelola mesin tabel lebar Lindorm dari perangkat on-premises, terapkan lindorm-cli pada perangkat lokal dan hubungkan ke mesin tabel lebar Lindorm melalui jaringan publik.
Catatan-
Menghubungkan melalui jaringan publik tidak dikenai biaya traffic tetapi menimbulkan risiko keamanan. Kami menyarankan menggunakan VPC untuk keamanan yang lebih tinggi.
-
Anda harus mengaktifkan titik akhir publik di Konsol. Untuk informasi selengkapnya, lihat Prosedur.
-
Instalasi
-
Unduh paket instalasi Lindorm-cli yang sesuai dengan sistem operasi Anda. Tautan unduhan tercantum dalam tabel berikut.
CatatanChecksum SHA256 dalam tabel dapat digunakan untuk memverifikasi integritas dan keaslian paket Lindorm-cli yang diunduh.
Sistem operasi
Tautan unduh
Checksum SHA256
Linux
Perintah unduh langsung:
wget https://hbaseuepublic.oss-cn-beijing.aliyuncs.com/lindorm-cli-linux-latest.tar.gzfdd0cdece2a3d29124dd9538edefdd66532b950653f049d6b4fd6a21cb2cd6fc
Linux-arm64
Perintah unduh langsung:
wget https://hbaseuepublic.oss-cn-beijing.aliyuncs.com/lindorm-cli-linux-arm64-latest.tar.gzbd602405a2e988cf77d6b3afa2aac35ce72b437038119f4b3a9d926d3ffb5be1
Mac (chip Intel)
cfff2a661fe6d48e0d55dbfca149847a3b8c0ef391d59e4694a425a22a44f5be
Mac (chip Arm)
1aae53cf83ad40a7386ea5711684d733e9728566c3f7463d00070a56201b79dc
Windows
cf2330fac41cc3d731282cd8dddfd5656ad05c1f8e1113607cf427d0614b23b6
-
Ekstrak paket Lindorm-cli.
Gunakan metode ekstraksi standar untuk sistem operasi Anda guna mengekstrak paket yang telah diunduh.
Untuk Linux, jalankan perintah berikut untuk mengekstrak paket. Setelah diekstrak, Anda mendapatkan file
lindorm-cli. File yang dapat dieksekusi ini dapat dijalankan langsung di terminal shell tanpa langkah instalasi tambahan.tar zxvf lindorm-cli-linux-latest.tar.gz
Metode koneksi
Lindorm-cli mendukung penghubungan ke mesin tabel lebar Lindorm menggunakan protokol MySQL, protokol Avatica, atau protokol native HBase. Kami menyarankan menggunakan protokol MySQL.
Hanya versi lindorm-cli 2.0.0 dan yang lebih baru yang mendukung penghubungan ke mesin tabel lebar menggunakan protokol MySQL.
Hanya versi lindorm-cli 2.4.0 dan yang lebih baru yang mendukung penghubungan ke mesin tabel lebar menggunakan protokol HBase.
Menghubungkan ke mesin tabel lebar menggunakan protokol MySQL (disarankan)
Client diterapkan di Linux atau Mac
-
Buka direktori yang berisi
Lindorm-cli.cd <direktori Lindorm-cli> -
Jalankan perintah berikut untuk menghubungkan ke mesin tabel lebar.
./lindorm-cli -url <mysql url> -username <username> -password <password>Deskripsi parameter
Parameter
Deskripsi
mysql url
Titik akhir yang kompatibel dengan MySQL dari mesin tabel lebar Lindorm. Untuk detail konfigurasi koneksi lebih lanjut, lihat Konfigurasi koneksi.
username
Username untuk menghubungkan ke mesin tabel lebar Lindorm.
password
Password untuk menghubungkan ke mesin tabel lebar Lindorm.
Penting-
Jika Anda lupa password, Anda dapat mengatur ulang password pengguna di sistem manajemen kluster mesin tabel lebar Lindorm.
-
Setelah mengatur ulang password, restart engine di Konsol.
Konfigurasi koneksi
Konfigurasi koneksi yang didukung
Deskripsi
mysql://header protokolAnda dapat menambahkan header protokol
mysql://di awal mysql url.Contoh:
mysql://ld-8vbn68478unu8****-proxy-sql-lindorm.lindorm.rds.aliyuncs.com:33060.Parameter koneksi kustom sisi server
Anda dapat menambahkan parameter koneksi kustom sisi server ke mysql url dalam format
key1=value1&key2=value2.Parameter berikut saat ini didukung:
operationTimeout: Menentukan periode timeout kueri. Formatnya adalah
<mysql url>?operationTimeout=<timeout>, dengan satuan timeout dalam milidetik (ms). Contoh:ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000.PentingHanya versi mesin tabel lebar 2.7.7 dan yang lebih baru yang mendukung parameter operationTimeout. Untuk informasi tentang cara melihat atau meningkatkan versi Anda saat ini, lihat Panduan versi mesin tabel lebar dan Peningkatan versi minor.
Contoh koneksi
./lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test --Tambahkan header protokol mysql:// ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test --Tentukan timeout kueri ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password testKoneksi yang berhasil mengembalikan hasil berikut:
lindorm-cli version: 2.0.xDi sini,
2.0.xadalah nomor versi Lindorm-cli. -
Client diterapkan di Windows
Metode 1
-
Buka Command Prompt (CMD) dan buka direktori yang berisi
lindorm-cli.exe.cd <direktori lindorm-cli.exe> -
Jalankan perintah berikut di CMD untuk menghubungkan ke mesin tabel lebar.
lindorm-cli -url <mysql url> -username <username> -password <password>Deskripsi parameter
Parameter
Nilai contoh
Cara memperoleh
mysql url
ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060
Titik akhir yang kompatibel dengan MySQL dari mesin tabel lebar Lindorm. Untuk detail konfigurasi koneksi lebih lanjut, lihat Konfigurasi koneksi.
username
user
Username untuk menghubungkan ke mesin tabel lebar Lindorm.
password
test
Password untuk menghubungkan ke mesin tabel lebar Lindorm.
Penting-
Jika Anda lupa password, Anda dapat mengatur ulang password pengguna di sistem manajemen kluster mesin tabel lebar Lindorm.
-
Setelah mengatur ulang password, restart engine di Konsol.
Konfigurasi koneksi
Konfigurasi koneksi yang didukung
Deskripsi
mysql://header protokolAnda dapat menambahkan header protokol
mysql://di awal mysql url.Contoh:
mysql://ld-8vbn68478unu8****-proxy-sql-lindorm.lindorm.rds.aliyuncs.com:33060.Parameter koneksi kustom sisi server
Anda dapat menambahkan parameter koneksi kustom sisi server ke mysql url dalam format
key1=value1&key2=value2.Parameter yang didukung adalah sebagai berikut:
operationTimeout: Menentukan periode timeout kueri. Formatnya adalah
<mysql url>?operationTimeout=<timeout>, dengan satuan timeout dalam milidetik (ms). Contoh:ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000.PentingHanya versi mesin tabel lebar 2.7.7 dan yang lebih baru yang mendukung parameter operationTimeout. Untuk informasi tentang cara melihat atau meningkatkan versi Anda saat ini, lihat Panduan versi mesin tabel lebar dan Peningkatan versi minor.
Contoh koneksi
lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test --Tambahkan header protokol mysql:// lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test --Tentukan timeout kueri lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password testKoneksi yang berhasil mengembalikan hasil berikut:
Connected to ld-bp187uwcx5f40****-proxy-sql-lindorm-public.lindorm.rds.aliyuncs.com:33060 lindorm-cli version: 2.0.xDi sini,
2.0.xadalah nomor versi Lindorm-cli. -
Metode 2
Klik ganda untuk membuka program Lindorm-cli.exe dan jalankan perintah berikut:
connect <mysql url> <username> <password>
Contoh koneksi
connect ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:33060 user test
Koneksi yang berhasil tidak mengembalikan output apa pun.
Menghubungkan ke mesin tabel lebar menggunakan protokol Avatica
Client diterapkan di Linux atau Mac
-
Buka direktori yang berisi
Lindorm-cli.cd <direktori Lindorm-cli> -
Jalankan perintah berikut untuk menghubungkan ke mesin tabel lebar.
./lindorm-cli -url <url> -username <username> -password <password>Deskripsi parameter
Parameter
Nilai contoh
Cara memperoleh
jdbc url
jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060
Titik akhir SQL tabel lebar dari mesin tabel lebar Lindorm.
username
user
Username untuk menghubungkan ke mesin tabel lebar Lindorm.
password
test
Password untuk menghubungkan ke mesin tabel lebar Lindorm.
Penting-
Jika Anda lupa password, Anda dapat mengatur ulang password pengguna di sistem manajemen kluster mesin tabel lebar Lindorm.
-
Setelah mengatur ulang password, restart engine di Konsol.
Contoh koneksi
./lindorm-cli -url jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060 -username user -password testKoneksi yang berhasil mengembalikan hasil berikut:
lindorm-cli version: 2.0.xxDi sini,
2.0.xxadalah nomor versi Lindorm-cli. -
Client diterapkan di Windows
Metode 1
-
Buka Command Prompt (CMD) dan buka direktori yang berisi
lindorm-cli.exe.cd <direktori lindorm-cli.exe> -
Jalankan perintah berikut di CMD untuk menghubungkan ke mesin tabel lebar.
lindorm-cli -url <jdbc url> -username <username> -password <password>Deskripsi parameter
Parameter
Nilai contoh
Cara memperoleh
jdbc url
jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060
Titik akhir SQL tabel lebar dari mesin tabel lebar Lindorm.
username
user
Username untuk menghubungkan ke mesin tabel lebar Lindorm.
password
test
Password untuk menghubungkan ke mesin tabel lebar Lindorm.
Penting-
Jika Anda lupa password, Anda dapat mengatur ulang password pengguna di sistem manajemen kluster mesin tabel lebar Lindorm.
-
Setelah mengatur ulang password, restart engine di Konsol.
Contoh koneksi
lindorm-cli -url jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:30060 -username user -password testKoneksi yang berhasil mengembalikan hasil berikut:
Connected to jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060 lindorm-cli version: 2.0.xxDi sini,
2.0.xxadalah nomor versi Lindorm-cli. -
Metode 2
Klik ganda untuk membuka program Lindorm-cli.exe dan jalankan perintah berikut:
connect <jdbc url> <username> <password>
Contoh koneksi
connect jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:30060 user test
Koneksi yang berhasil tidak mengembalikan output apa pun.
Menghubungkan ke mesin tabel lebar menggunakan protokol native HBase
Hanya versi lindorm-cli 2.4.0 dan yang lebih baru yang mendukung penghubungan ke mesin tabel lebar menggunakan protokol HBase.
Kapan menggunakan mode HBase
Dalam sebagian besar skenario, kami menyarankan menggunakan protokol MySQL (atau protokol Avatica) untuk mengakses mesin tabel lebar melalui SQL: SQL mendukung seluruh kemampuan tabel lebar (indeks sekunder, kueri multi-kolom, agregasi, paginasi, dan lainnya) dengan ekosistem dan rantai alat yang lebih kaya.
Mode HBase hanya disarankan dalam skenario berikut:
Data yang dimigrasikan dari HBase open-source: Tabel dan data Anda awalnya disimpan di HBase open-source dan telah dimigrasikan ke mesin tabel lebar Lindorm menggunakan alat seperti LTS.
Kebiasaan atau skrip HBase yang sudah ada: Anda terbiasa dengan sintaks perintah HBase Shell (
create,put,get,scan,describe, dll.) dan ingin menggunakan perintah tersebut secara langsung tanpa menulis ulang dalam SQL.Manajemen tabel bergaya HBase: Anda perlu melakukan operasi seperti mengatur atribut keluarga kolom atau mengelola namespace.
Metode koneksi
Mode HBase menggunakan format URL khusus hbase://<host>:<port>:
./lindorm-cli -url "hbase://<host>:30020" -username <username>
Awalan hbase:// bersifat wajib. Berbeda dengan protokol MySQL di mana awalan mysql:// bersifat opsional, menghilangkan awalan hbase:// akan menyebabkan koneksi diuraikan sebagai protokol MySQL, bukan mode HBase.
Password bersifat opsional dalam mode HBase. Jika otentikasi diperlukan, masukkan melalui parameter -password atau Variabel lingkungan LINDORM_PASSWORD.
Setelah koneksi berhasil, Anda dapat memasukkan perintah HBase Shell secara langsung di antarmuka interaktif. Perintah HBase tidak diakhiri dengan titik koma (;). Tekan Enter untuk menjalankan setiap perintah.
Penggunaan
Lindorm-cli mendukung mode interaktif dan non-interaktif untuk menjalankan pernyataan SQL terhadap mesin tabel lebar.
Menjalankan pernyataan SQL dalam mode interaktif
Dalam sebagian besar kasus, Anda memulai lindorm-cli dalam mode interaktif untuk mengoperasikan mesin tabel lebar. Alur kerjanya sebagai berikut:
-
Jalankan lindorm-cli
Setelah menghubungkan ke mesin tabel lebar Lindorm menggunakan protokol apa pun yang dijelaskan di bagian sebelumnya, terminal Anda memasuki antarmuka interaktif lindorm-cli dan menunggu perintah lebih lanjut.CatatanDi Windows, mengklik ganda lindorm-cli.exe membuka jendela terminal CMD. Ini memulai antarmuka interaktif lindorm-cli tetapi tidak membuat koneksi ke mesin tabel lebar Lindorm. Anda harus menggunakan subperintah connect untuk membuat koneksi sebelum menjalankan pernyataan SQL. Untuk informasi selengkapnya, lihat Client diterapkan di Windows dan Metode 2.
-
Masukkan pernyataan SQL untuk mengakses mesin tabel lebar
Setelah membuat koneksi dan memasuki antarmuka interaktif, masukkan pernyataan SQL untuk mengakses mesin tabel lebar. Untuk sintaks SQL yang didukung, lihat Referensi SQL. -
Keluar dari lindorm-cli
Setelah menyelesaikan operasi Anda di antarmuka interaktif, keluar dari lindorm-cli dengan menjalankan subperintahexitatau menekan pintasan keyboardctrl+d.
Setelah memulai lindorm-cli dalam mode interaktif dan berhasil menghubungkan ke mesin tabel lebar, client mempertahankan session dengan engine hingga Anda keluar. Semua operasi SQL selama periode ini dijalankan dalam session yang sama. Perhatikan bahwa jika session tidak aktif terlalu lama, sistem akan memutus koneksi secara otomatis untuk menghemat sumber daya.
Menjalankan pernyataan SQL dalam mode non-interaktif
Saat menulis skrip O&M, untuk langsung menjalankan pernyataan SQL Lindorm tanpa memasuki baris perintah interaktif, Anda dapat menggunakan mode non-interaktif lindorm-cli untuk bekerja dengan LindormTable. Mode ini langsung menjalankan SQL melalui parameter perintah dan mengembalikan hasilnya, sehingga cocok untuk tugas otomatis seperti menjalankan kueri atau operasi statistik.
Untuk menjalankan pernyataan SQL dalam mode non-interaktif dari terminal shell, tambahkan parameter -execute diikuti pernyataan SQL yang diapit tanda kutip tunggal atau ganda ke parameter koneksi (seperti alamat host dan port) yang dijelaskan di Metode koneksi. Hal ini dengan cepat membuat koneksi singkat dan menjalankan perintah. Contoh:
lindorm-cli -url mysql://ld-xxxxxx-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password XXXX -execute "CREATE TABLE tb (id VARCHAR, name VARCHAR, address VARCHAR, PRIMARY KEY(id, name));"
Anda juga dapat mengekspor hasil kueri tabel lebar ke file CSV menggunakan mode non-interaktif.
Mengekspor ke CSV memerlukan lindorm-cli versi 2.2.0 atau yang lebih baru. Untuk memeriksa versi Anda saat ini:
-
Jalankan
lindorm-cli -versiondi baris perintah. -
Periksa versi yang ditampilkan dalam pesan sambutan saat memasuki mode interaktif.
lindorm-cli -url mysql://ld-xxxxxx-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password XXXX -format csv -output ~/result.csv -execute "SELECT * FROM tb;"
-
Koneksi singkat: Dalam mode non-interaktif, lindorm-cli membuat koneksi baru untuk setiap pernyataan SQL dan menutupnya segera setelah eksekusi.
-
Kontrol output: Hasil dicetak ke layar terminal (stdout) secara default. Untuk mengarahkan output ke file, gunakan parameter
-output.
Gunakan lindorm-cli dengan AI Agent
Selain mode interaktif dan non-interaktif, lindorm-cli juga dapat dipanggil oleh AI Agent. Saat Anda ingin menggunakan bahasa alami agar AI Agent secara otomatis melakukan kueri data Lindorm, analisis hasil, atau pembuatan skrip O&M, Anda dapat menggabungkan Lindorm Agent Skill dengan lindorm-cli.
Kemampuan berorientasi AI Agent yang dijelaskan di bawah ini memerlukan lindorm-cli versi 2.3.0 atau yang lebih baru.
Skenario
Menggunakan lindorm-cli melalui AI Agent cocok untuk skenario berikut:
-
Kueri data dengan bahasa alami: Jelaskan maksud kueri Anda dalam bahasa alami. Agent akan menghasilkan dan menjalankan pernyataan SQL serta mengembalikan hasil terstruktur.
-
Pembuatan skrip O&M batch: Biarkan Agent menghasilkan skrip yang memanggil lindorm-cli berdasarkan kebutuhan Anda untuk tugas terjadwal atau pemrosesan data batch.
-
Ekspor hasil terstruktur: Gunakan Agent untuk mengekspor hasil kueri langsung dalam format yang dapat diurai mesin seperti JSON atau JSONL untuk pemrosesan lanjutan.
Instal Lindorm Agent Skill
Lindorm Agent Skill menyediakan konteks yang dibutuhkan AI Agent untuk memanggil lindorm-cli. Skill ini memandu Agent untuk secara otomatis mendeteksi instalasi lindorm-cli lokal, memilih parameter yang sesuai, dan menyusun perintah.
Anda dapat mengunduh Lindorm Agent Skill dari: alibabacloud-lindorm-agent-skill
Setelah instalasi, Agent dapat memanggil lindorm-cli untuk mengakses mesin tabel lebar Lindorm langsung dalam percakapan. Skill ini memperkuat (solidifies) kemampuan CLI dan parameter yang dijelaskan di bawah, sehingga Anda biasanya tidak perlu memasukkan parameter tersebut secara manual.
Penggunaan Agen
Setelah menginstal Lindorm Agent Skill, Anda hanya perlu menjelaskan kebutuhan Anda dalam bahasa alami. Agent secara otomatis melakukan deteksi, kueri, kontrol keamanan, dan injeksi kredensial di bawah panduan Skill.
Agent secara otomatis mendeteksi kemampuan lindorm-cli
Sebelum pemanggilan pertama, Agent mendeteksi versi lindorm-cli, protokol yang didukung, format output, dan definisi kode keluar di lingkungan saat ini. Hal ini memungkinkan Agent memilih metode pemanggilan yang benar berdasarkan lingkungan aktual, bukan mengandalkan asumsi yang dikodekan.
Perilaku ini tertanam dalam Lindorm Agent Skill dan sesuai dengan parameter --capabilities lindorm-cli.
Agent mengembalikan hasil dalam format terstruktur
Saat Agent menjalankan kueri, Agent meminta lindorm-cli mengeluarkan hasil dalam format JSON atau JSONL. Hanya data hasil kueri yang dikirim ke stdout; pesan status dan peringatan dikirim ke stderr. Kedua aliran ini diisolasi untuk memudahkan penguraian oleh Agent.
Untuk set hasil besar, Agent menggunakan format JSONL untuk mengonsumsi hasil baris demi baris, menghindari pemuatan semua data sekaligus.
Perilaku ini tertanam dalam Lindorm Agent Skill dan sesuai dengan parameter -format json dan -format jsonl lindorm-cli.
Agent mengaktifkan pembatas keamanan
Lindorm Agent Skill mengaktifkan safe mode secara default, mencegat operasi tulis berisiko tinggi seperti DROP TABLE, TRUNCATE TABLE, dan DELETE FROM di sisi client untuk mencegah Agent secara tidak sengaja menjalankan SQL destruktif. Skill ini juga membatasi jumlah maksimum baris yang dikembalikan per kueri untuk mencegah set hasil besar menghabiskan jendela konteks Agent.
Perilaku ini tertanam dalam Lindorm Agent Skill dan sesuai dengan parameter --safe-mode dan --max-rows lindorm-cli.
Agent secara aman menginjeksikan kredensial
Saat Agent memanggil lindorm-cli, Skill memprioritaskan injeksi username dan password melalui variabel lingkungan atau input standar, mencegah kredensial muncul di argumen baris perintah, riwayat Shell, atau daftar proses.
Perilaku ini tertanam dalam Lindorm Agent Skill dan sesuai dengan injeksi kredensial variabel lingkungan dan parameter --password-stdin lindorm-cli.
Parameter baris perintah dan subperintah
Parameter baris perintah
Saat menjalankan lindorm-cli di terminal, Anda dapat menentukan parameter baris perintah berikut:
|
Nama parameter |
Memerlukan nilai |
Nilai |
Deskripsi |
|
url |
Ya |
Nama protokol + string koneksi SQL (termasuk port) untuk mesin tabel lebar Lindorm |
Menentukan protokol dan string koneksi untuk lindorm-cli menghubungkan ke mesin tabel lebar.
|
|
username |
Ya |
Username untuk koneksi |
Username yang ditentukan harus merupakan pengguna Lindorm yang telah dibuat di mesin tabel lebar. |
|
password |
Ya |
Password untuk username |
- |
|
database |
Ya |
Nama database yang akan dihubungkan |
Jika tidak ditentukan, database default digunakan. Jika ditentukan, database tersebut harus sudah ada di mesin tabel lebar. |
|
execute |
Ya |
Pernyataan SQL yang akan dijalankan |
Saat parameter execute ditentukan, lindorm-cli berjalan dalam mode non-interaktif. Bungkus pernyataan SQL dengan tanda kutip tunggal atau ganda. Catatan
Saat menggunakan tanda kutip ganda untuk membungkus pernyataan SQL, escape tanda kutip ganda internal dengan backslash |
|
output |
Ya |
Lokasi output untuk hasil eksekusi SQL dalam mode non-interaktif |
Dalam mode non-interaktif, jika output tidak ditentukan, hasil dicetak ke output standar. Jika ditentukan, hasil ditulis ke file pada path yang diberikan. Jika file tidak ada, file tersebut akan dibuat. |
|
format |
Ya |
Salah satu dari berikut: horizontal, vertical, csv, json, column |
Mengubah format hasil eksekusi SQL yang dikembalikan oleh mesin tabel lebar. Format default adalah column.
|
|
pretty |
Tidak |
- |
Gunakan dengan format diatur ke JSON. Saat diaktifkan, hasil dikeluarkan sebagai JSON pretty-printed. Secara default, hasil dikeluarkan sebagai JSON compact. |
|
csvNoHeader |
Tidak |
- |
Gunakan dengan format diatur ke CSV. Saat diaktifkan, hasil dikeluarkan dalam format CSV tanpa header kolom. |
|
nullString |
Ya |
String untuk mengganti nilai NULL |
Gunakan dengan format diatur ke CSV. Saat ditentukan, nilai NULL dalam hasil kueri diganti dengan string yang diberikan. Jika nullString tidak ditentukan, nilai NULL dikeluarkan sebagai berikut:
|
|
version |
Tidak |
- |
Menampilkan informasi versi lindorm-cli. Lindorm-cli tidak dimulai atau memasuki mode interaktif saat parameter ini digunakan. |
|
format |
Ya |
Salah satu: horizontal, vertical, csv, json, jsonl, column |
Mengubah format hasil eksekusi SQL yang dikembalikan oleh mesin tabel lebar. Default adalah column.
|
|
capabilities |
Tidak |
- |
Mengeluarkan deklarasi kemampuan JSON lindorm-cli, termasuk engine yang didukung, format, kode keluar, dan parameter. Dalam skenario AI Agent, ini dipanggil secara otomatis oleh Lindorm Agent Skill. |
|
safe-mode |
Tidak |
- |
Saat diaktifkan, client mencegat operasi tulis berisiko tinggi seperti DROP TABLE, TRUNCATE TABLE, dan DELETE FROM. Dalam skenario AI Agent, ini diaktifkan secara default oleh Lindorm Agent Skill. |
|
max-rows |
Ya |
Bilangan bulat positif |
Membatasi jumlah maksimum baris yang dikembalikan oleh client. Baris berlebih dipotong. Dalam skenario AI Agent, ini diatur secara default oleh Lindorm Agent Skill untuk mencegah set hasil besar menghabiskan jendela konteks Agent. |
|
password-stdin |
Tidak |
- |
Membaca password dari input standar untuk mencegahnya muncul di argumen baris perintah. Dalam skenario AI Agent, Lindorm Agent Skill memprioritaskan ini daripada parameter |
Semua parameter baris perintah lindorm-cli harus diawali dengan tanda hubung -.
Subperintah umum
Setelah menjalankan lindorm-cli dalam mode interaktif, Anda dapat menjalankan subperintah lindorm-cli di antarmuka interaktif untuk mengontrol perilakunya, selain mengirim pernyataan SQL ke mesin tabel lebar Lindorm. Subperintah umum tercantum di bawah ini:
|
Subperintah |
Parameter |
Deskripsi |
|
connect |
<url> <username> <password> |
Saat lindorm-cli dimulai dalam mode interaktif tanpa koneksi, gunakan subperintah connect untuk membuat koneksi ke mesin tabel lebar Lindorm. Parameter url, username, dan password memiliki makna yang sama dengan parameter baris perintah |
|
format |
Salah satu dari berikut: horizontal, vertical, csv, json |
Sama dengan parameter |
|
help |
Tidak ada |
Menampilkan daftar subperintah umum. |
|
history |
Tidak ada |
Menampilkan pernyataan SQL atau subperintah yang baru saja dijalankan. |
|
exit atau quit |
Tidak ada |
Keluar dari lindorm-cli dan memutus koneksi dari mesin tabel lebar Lindorm. |
FAQ
Mengapa saya mengalami timeout koneksi atau kegagalan koneksi?
Timeout koneksi atau kegagalan koneksi mengembalikan error seperti Failed to connect to <wide table endpoint> connection check failed atau connection timeout.
Penyebab dan solusi yang mungkin tercantum di bawah ini. Periksa secara berurutan:
|
Penyebab |
Solusi |
|
Menggunakan koneksi jaringan publik tanpa menambahkan alamat IP publik ke daftar putih. |
Tambahkan alamat IP publik client ke daftar putih Lindorm. Untuk menemukan alamat IP publik client Anda, jalankan |
|
Alamat IP publik telah ditambahkan ke daftar putih, tetapi timeout koneksi tetap terjadi. |
Ketidakstabilan jaringan mungkin menjadi penyebabnya. Kami menyarankan beralih ke koneksi VPC. |
|
Mengakses dari Instance ECS tanpa menambahkan alamat IP ECS ke daftar putih Lindorm. |
Dapatkan alamat IP ECS dan tambahkan ke daftar putih Lindorm. |
|
Menggunakan titik akhir yang salah. |
Titik akhir Lindorm berbeda untuk koneksi VPC dan jaringan publik. Gunakan titik akhir yang benar berdasarkan lingkungan jaringan Anda. |
Jika solusi di atas tidak menyelesaikan masalah Anda, hubungi dukungan teknis Lindorm (ID DingTalk: s0s3eg3).
Referensi
-
Untuk informasi tentang sintaks SQL tabel lebar Lindorm, lihat Referensi SQL.
-
Metode koneksi lainnya: Menghubungkan ke dan menggunakan mesin tabel lebar dengan baris perintah MySQL, Gunakan protokol MySQL (disarankan).