Hubungkan ke LindormTable menggunakan Lindorm-cli - Lindorm

Lindorm-cli adalah antarmuka baris perintah (CLI) sederhana yang disediakan oleh Lindorm untuk menghubungkan dan mengelola database Lindorm. Anda dapat menggunakan 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 Lindorm LindormTable menggunakan Lindorm-cli.

Prasyarat

Lingkungan tempat Anda menjalankan Lindorm-cli disebut sebagai lingkungan client. Sebelum menggunakan Lindorm-cli untuk mengakses LindormTable, pastikan hal-hal berikut:

Alamat IP client telah ditambahkan ke daftar putih Lindorm. Untuk informasi selengkapnya, lihat Setel daftar putih.

Jenis jaringan untuk koneksi antara lingkungan client dan Lindorm.

Jenis jaringan berikut dapat digunakan untuk menghubungkan ke LindormTable:

Jenis jaringan	Deskripsi
Virtual private cloud (VPC) (Direkomendasikan)	Virtual private cloud (VPC) adalah jaringan pribadi Anda di cloud. VPC yang berbeda memiliki isolasi logis layer 2 untuk keamanan tinggi. Saat lindorm-cli dideploy pada Instance ECS, menghubungkan ke LindormTable melalui VPC memberikan keamanan lebih tinggi dan latensi jaringan lebih rendah.
Jaringan publik	Jaringan publik adalah Internet. Untuk menguji atau mengelola LindormTable dari perangkat on-premises, deploy lindorm-cli pada perangkat tersebut dan hubungkan ke LindormTable melalui jaringan publik. Catatan Menghubungkan melalui jaringan publik tidak dikenai biaya trafik tetapi menimbulkan risiko keamanan. Gunakan koneksi melalui VPC untuk keamanan lebih tinggi. Anda harus mengaktifkan titik akhir publik di Konsol. Untuk informasi selengkapnya, lihat Prosedur.

Metode instalasi

Unduh paket instalasi Lindorm-cli untuk sistem operasi Anda. Tautan unduhan tersedia dalam tabel berikut.

Catatan

Anda dapat menggunakan checksum SHA256 dalam tabel berikut untuk memverifikasi integritas dan keaslian paket instalasi Lindorm-cli yang diunduh.

Sistem operasi	Tautan unduhan	Checksum SHA256
Linux	lindorm-cli for linux Perintah unduh langsung: `wget https://tsdbtools.oss-cn-hangzhou.aliyuncs.com/lindorm-cli-linux-latest.tar.gz`	0f4ccaf214b41fdf8d3dd5f0ed4f92f1d5e6b0a11da3d217c9df6d382f0080df
Linux (arm64)	lindorm-cli for linux-arm64 Perintah unduh langsung: `wget https://tsdbtools.oss-cn-hangzhou.aliyuncs.com/lindorm-cli-linux-arm64-latest.tar.gz`	1bfb992853a26c703b2d9e2bd50e4d7e31f88992bcb7e70ac30331f5998c269e
Mac (chip Intel)	lindorm-cli for mac	af8a78bfe8ef53d1df25df99b5803ef3f55da7e943d730a1a6d44cd918f28842
Mac (chip Arm)	lindorm-cli for mac	5bdc8600055432a9275a0d52e5d26e6c2cfc7a553961c09681d0388a5a5e9a62
Windows	lindorm-cli for windows-x64	7721748744edc551d43fec6bb19ab40eb514bb6043a3d21afa38f353833259ce

Ekstrak paket Lindorm-cli.
Gunakan metode standar untuk sistem operasi Anda guna mengekstrak paket yang telah diunduh.
Sebagai contoh, pada sistem operasi Linux, Anda dapat menjalankan perintah berikut untuk mengekstrak paket tersebut. Setelah proses ekstraksi selesai, file yang dapat dieksekusi bernama lindorm-cli akan dihasilkan. Anda dapat langsung menjalankan file ini di terminal shell tanpa perlu instalasi tambahan.
```
tar zxvf lindorm-cli-linux-latest.tar.gz
```

Metode koneksi

Lindorm-cli mendukung koneksi ke LindormTable menggunakan protokol MySQL atau protokol Avatica. Kami merekomendasikan penggunaan protokol MySQL.

Penting

Hanya Lindorm-cli versi 2.0.0 dan yang lebih baru yang mendukung koneksi ke LindormTable menggunakan protokol MySQL.

Hubungkan ke LindormTable menggunakan protokol MySQL (Direkomendasikan)

Client dideploy pada Linux atau macOS

Buka folder tempat Lindorm-cli berada.
```
cd <folder_of_Lindorm-cli>
```

Jalankan pernyataan berikut untuk menghubungkan ke LindormTable.

./lindorm-cli -url <mysql url> -username <username> -password <password>

Deskripsi parameter

Parameter	Deskripsi
mysql url	Titik akhir kompatibel MySQL LindormTable. Untuk informasi lebih lanjut tentang konfigurasi koneksi, lihat Konfigurasi koneksi.
username	Username untuk menghubungkan ke LindormTable.
password	Password untuk menghubungkan ke LindormTable. Penting Jika Anda lupa password, ubah password pengguna di sistem manajemen kluster LindormTable. Setelah mengubah password, restart engine di Konsol.

Konfigurasi koneksi

Konfigurasi koneksi yang didukung

Deskripsi

mysql:// header protokol

Tambahkan header protokol mysql:// di awal mysql url.

Contoh: mysql://ld-8vbn68478unu8****-proxy-sql-lindorm.lindorm.rds.aliyuncs.com:33060.

Parameter koneksi kustom sisi server

Atur parameter koneksi kustom sisi server setelah mysql url dalam format key1=value1&key2=value2.

Parameter berikut didukung:

operationTimeout: Periode timeout kueri. Formatnya adalah <mysql url>?operationTimeout=<timeout_period>. Periode timeout dalam milidetik (ms). Contoh: ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000.

Penting

Hanya mesin LindormTable versi 2.7.7 dan yang lebih baru yang mendukung parameter operationTimeout. Untuk melihat atau meningkatkan versi saat ini, lihat Panduan versi LindormTable dan Lakukan peningkatan versi minor.

Contoh koneksi

./lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test

--Hubungkan dengan header protokol mysql://
./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test

--Tentukan periode timeout kueri
./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

Jika koneksi berhasil, hasil berikut dikembalikan:

lindorm-cli version: 2.0.x

Pada output tersebut, 2.0.x adalah nomor versi Lindorm-cli.

Client dideploy pada Windows

Metode 1

Buka Command Prompt (CMD) dan buka folder tempat lindorm-cli.exe berada.
```
cd <folder_of_lindorm-cli.exe>
```

Di CMD, jalankan pernyataan berikut untuk menghubungkan ke LindormTable.

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 kompatibel MySQL LindormTable. Untuk informasi lebih lanjut tentang konfigurasi koneksi, lihat Konfigurasi koneksi.
username	user	Username untuk menghubungkan ke LindormTable.
password	test	Password untuk menghubungkan ke LindormTable. Penting Jika Anda lupa password, ubah password pengguna di sistem manajemen kluster LindormTable. Setelah mengubah password, restart engine di Konsol.

Konfigurasi koneksi

Konfigurasi koneksi yang didukung

Deskripsi

mysql:// header protokol

Tambahkan header protokol mysql:// di awal mysql url.

Contoh: mysql://ld-8vbn68478unu8****-proxy-sql-lindorm.lindorm.rds.aliyuncs.com:33060.

Parameter koneksi kustom sisi server

Atur parameter koneksi kustom sisi server setelah mysql url dalam format key1=value1&key2=value2.

Parameter berikut didukung:

Penting

Contoh koneksi

lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test

--Hubungkan dengan header protokol mysql://
lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test

--Tentukan periode timeout kueri
lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

Jika koneksi berhasil, hasil berikut dikembalikan:

Connected to ld-bp187uwcx5f40****-proxy-sql-lindorm-public.lindorm.rds.aliyuncs.com:33060
lindorm-cli version: 2.0.x

Pada output tersebut, 2.0.x adalah nomor versi Lindorm-cli.

Metode 2

Klik ganda file `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

Tidak ada pesan yang dikembalikan untuk koneksi yang berhasil.

Hubungkan ke LindormTable menggunakan protokol Avatica

Client dideploy pada Linux atau macOS

Buka direktori yang berisi Lindorm-cli.
```
cd <directory_of_Lindorm-cli>
```

Jalankan pernyataan 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 LindormTable LindormTable.
Username	user	Username untuk menghubungkan ke LindormTable.
Password	test	Password untuk menghubungkan ke LindormTable. Penting Jika Anda lupa password, ubah password pengguna di sistem manajemen kluster LindormTable. Setelah mengubah 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 test

Jika koneksi berhasil, hasil berikut dikembalikan:

lindorm-cli version: 2.0.xx

Pada hasil tersebut, 2.0.xx adalah nomor versi Lindorm-cli.

Client dideploy pada Windows

Metode 1

Buka Command Prompt (CMD) dan buka direktori yang berisi lindorm-cli.exe.
```
cd <directory_of_lindorm-cli.exe>
```

Di command prompt, jalankan pernyataan berikut 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	Alamat SQL tabel lebar untuk LindormTable.
Username	user	Username untuk menghubungkan ke LindormTable.
Password	test	Password untuk menghubungkan ke LindormTable. Penting Jika Anda lupa password, ubah password pengguna di sistem manajemen kluster LindormTable. Setelah mengubah 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 test

Jika koneksi berhasil, hasil berikut dikembalikan:

Connected to jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060
lindorm-cli version: 2.0.xx

Pada hasil tersebut, 2.0.xx adalah nomor versi Lindorm-cli.

Metode 2

Klik ganda file Lindorm-cli.exe dan jalankan pernyataan 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 menghasilkan output apa pun.

Penggunaan

Anda dapat menggunakan Lindorm-cli untuk menjalankan Pernyataan SQL dan mengakses LindormTable dalam mode interaktif atau non-interaktif.

Jalankan Pernyataan SQL dalam mode interaktif

Dalam kebanyakan kasus, Anda dapat memulai Lindorm-cli dalam mode interaktif untuk mengelola LindormTable. Prosedurnya sebagai berikut:

Mulai Lindorm-cli
Sebagai contoh, setelah Anda menghubungkan ke LindormTable menggunakan salah satu protokol yang dijelaskan di bagian Metode koneksi, terminal Anda memasuki antarmuka interaktif Lindorm-cli dan menunggu Anda memasukkan perintah berikutnya.
Catatan
Jika Anda mengklik ganda file `lindorm-cli.exe` di Windows, jendela command prompt akan muncul. Ini memulai antarmuka interaktif Lindorm-cli, tetapi koneksi ke LindormTable belum terbentuk. Anda harus menggunakan subperintah `connect` untuk membuat koneksi sebelum dapat menjalankan Pernyataan SQL selanjutnya. Untuk informasi selengkapnya, lihat Client dideploy pada Windows dan Metode 2.
Masukkan Pernyataan SQL untuk mengakses LindormTable
Setelah Lindorm-cli membuat koneksi dan memasuki antarmuka interaktif, Anda dapat memasukkan Pernyataan SQL untuk mengakses LindormTable. Gambar berikut menunjukkan contoh cara membuat database, membuat tabel, menulis data, dan mengkueri data dalam mode interaktif.

Catatan
Untuk informasi selengkapnya tentang Pernyataan SQL yang didukung oleh LindormTable, lihat Referensi SQL.
Keluar dari Lindorm-cli
Setelah menjalankan pernyataan yang diperlukan di antarmuka interaktif Lindorm-cli, Anda dapat menggunakan subperintah exit atau pintasan keyboard Ctrl+D untuk keluar dari Lindorm-cli.

Catatan

Saat Anda memulai lindorm-cli dalam mode interaktif dan berhasil menghubungkan ke LindormTable, client mempertahankan sesi koneksi dengan LindormTable hingga Anda keluar. Semua operasi SQL selama periode ini dijalankan dalam sesi yang sama. Perhatikan bahwa jika sesi tidak aktif dalam waktu lama, sistem secara otomatis memutus koneksi untuk melepaskan sumber daya.

Jalankan Pernyataan SQL dalam mode non-interaktif

Jika Anda sedang menulis skrip O&M dan perlu menjalankan Pernyataan SQL Lindorm tanpa memasuki baris perintah interaktif, Anda dapat menggunakan mode non-interaktif lindorm-cli untuk mengelola LindormTable. Dalam mode ini, Pernyataan SQL dijalankan langsung menggunakan parameter perintah dan hasilnya dikembalikan. Mode ini 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 oleh Pernyataan SQL yang diapit tanda kutip tunggal atau ganda ke parameter koneksi yang dijelaskan di bagian Metode koneksi, seperti alamat host dan port. Tindakan ini membuat koneksi singkat dan menjalankan perintah tersebut. Sebagai 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 dalam mode non-interaktif.

Penting

Fitur ekspor file CSV memerlukan Lindorm-cli versi 2.2.0 atau yang lebih baru. Untuk memeriksa versi saat ini, lakukan salah satu operasi berikut:

Kueri dari baris perintah: Jalankan perintah lindorm-cli -version untuk memperoleh nomor versi.
Periksa prompt startup dalam mode interaktif: Saat memasuki antarmuka interaktif, pesan sambutan awal menampilkan nomor versi.

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;"

Catatan

Mekanisme koneksi singkat: Dalam mode non-interaktif, Lindorm-cli membuat koneksi terpisah untuk setiap Pernyataan SQL dan segera menutup koneksi setelah pernyataan tersebut dieksekusi.
Kontrol output: Secara default, hasil eksekusi dicetak ke terminal (stdout). Untuk mengarahkan output ke file, Anda dapat menggunakan parameter -output.

Parameter baris perintah dan subperintah

Parameter baris perintah

Saat memulai Lindorm-cli di terminal, Anda dapat menentukan parameter baris perintah berikut:

Nama parameter	Memerlukan nilai	Nilai parameter	Deskripsi
url	Ya	Nama protokol + string koneksi SQL (termasuk port) untuk LindormTable	Menentukan informasi protokol dan string koneksi yang digunakan lindorm-cli untuk menghubungkan ke LindormTable. Untuk menghubungkan menggunakan protokol MySQL, tentukan titik akhir kompatibel MySQL LindormTable. Untuk menghubungkan menggunakan protokol Avatica, tentukan titik akhir SQL LindormTable LindormTable.
username	Ya	Username untuk koneksi	Username yang ditentukan harus merupakan pengguna Lindorm yang telah dibuat di LindormTable.
password	Ya	Password untuk username	-
database	Ya	Nama database yang akan dihubungkan	Jika tidak ditentukan, database default akan dihubungkan. Jika ditentukan, harus merupakan database yang telah dibuat di LindormTable.
execute	Ya	Pernyataan SQL yang akan dijalankan	Jika Anda menentukan parameter execute, lindorm-cli berjalan dalam mode non-interaktif. Pernyataan SQL yang ditentukan dalam nilai parameter harus diapit tanda kutip tunggal atau ganda. Catatan Saat menggunakan tanda kutip ganda untuk mengapit Pernyataan SQL, Anda dapat melakukan escape tanda kutip ganda di dalam Pernyataan SQL dengan backslash (`\`). Namun, jika menggunakan tanda kutip tunggal, Anda tidak dapat menggunakan karakter escape.
output	Ya	Lokasi output untuk hasil eksekusi SQL dalam mode non-interaktif	Dalam mode non-interaktif, jika output tidak ditentukan, hasil eksekusi SQL dicetak ke output standar. Jika output ditentukan, hasil eksekusi SQL ditulis ke file yang ditentukan pada path yang ditentukan. Jika file tersebut tidak ada, lindorm-cli akan mencoba membuatnya.
format	Ya	Salah satu dari berikut ini: horizontal, vertical, csv, json, column	Mengubah format hasil eksekusi SQL yang dikembalikan oleh server LindormTable. Jika tidak ditentukan, format default adalah column. column: Menampilkan hasil dalam format tabel standar. horizontal: Menampilkan data secara horizontal, kolom per kolom. vertical: Menampilkan data baris per baris, dengan kolom setiap baris ditampilkan secara vertikal. Mirip dengan format `\G` di baris perintah MySQL. csv: Menampilkan hasil dalam format CSV tanpa garis tabel. json: Menampilkan hasil dalam format JSON.
pretty	Tidak	-	Gunakan bersama format yang diatur ke JSON. Saat switch pretty diaktifkan, informasi yang dikembalikan oleh server ditampilkan dalam format JSON Pretty-printed. Jika tidak ditentukan, output berada dalam format JSON terkompresi.
csvNoHeader	Tidak	-	Gunakan bersama format yang diatur ke CSV. Saat switch csvNoHeader diaktifkan, informasi yang dikembalikan oleh server ditampilkan dalam format CSV tanpa header set hasil (nama kolom).
nullString	Ya	String untuk menggantikan NULL	Gunakan bersama format yang diatur ke CSV. Saat nullString ditentukan, nilai NULL dalam hasil kueri yang dikembalikan oleh server diganti dengan string yang ditentukan. Jika nullString tidak ditentukan, nilai NULL dalam hasil kueri ditampilkan dalam format default berikut: Saat koneksi dibuat menggunakan protokol MySQL, nilai NULL direpresentasikan oleh `\N`. Saat koneksi dibuat menggunakan protokol Avatica, nilai NULL direpresentasikan oleh string kosong.
version	Tidak	-	Menampilkan informasi versi lindorm-cli. Dalam kasus ini, lindorm-cli tidak benar-benar dimulai, dan tidak memasuki mode interaktif.

Catatan

Semua parameter baris perintah Lindorm-cli harus diawali dengan tanda hubung (-).

Subperintah umum

Saat Anda memulai tool Lindorm-cli dalam mode interaktif, Anda dapat memasukkan subperintah Lindorm-cli di antarmuka interaktif untuk mengontrol perilaku Lindorm-cli, selain mengirimkan Pernyataan SQL ke LindormTable. Subperintah umum dijelaskan dalam tabel berikut:

Subperintah	Parameter perintah	Deskripsi
connect	<url> <username> <password>	Saat lindorm-cli dimulai dan memasuki mode interaktif tanpa koneksi awal, Anda dapat menggunakan subperintah connect untuk membuat koneksi ke LindormTable. Bidang url, username, dan password memiliki arti yang sama dengan parameter baris perintah `url`, `username`, dan `password`.
format	Salah satu dari berikut ini: horizontal, vertical, csv, json	Sama dengan parameter `format`.
help	Tidak ada	Menampilkan koleksi subperintah umum.
history	Tidak ada	Menampilkan Pernyataan SQL atau subperintah yang baru saja dijalankan.
exit atau quit	Tidak ada	Keluar dari lindorm-cli dan putuskan koneksi dari LindormTable.

FAQ

Mengapa koneksi mengalami timeout atau gagal?

Timeout atau kegagalan koneksi dapat mengembalikan pesan error seperti Failed to connect to <wide table endpoint> connection check failed atau connection timeout.

Periksa kemungkinan penyebab berikut untuk mengatasi masalah tersebut:

Penyebab	Solusi
Alamat IP publik untuk koneksi jaringan publik tidak ditambahkan ke daftar putih.	Tambahkan Alamat IP publik client ke daftar putih Lindorm. Untuk menemukan Alamat IP publik client, Anda dapat menjalankan perintah `curl ipinfo.io/ip` atau `curl ifconfig.me` di command prompt.
Koneksi mengalami timeout bahkan setelah Alamat IP publik ditambahkan ke daftar putih.	Konektivitas jaringan Anda mungkin tidak stabil. Kami merekomendasikan beralih ke koneksi Virtual Private Cloud (VPC).
Alamat IP Instance ECS tidak ditambahkan ke daftar putih Lindorm.	Ambil Alamat IP Instance ECS dan tambahkan ke daftar putih Lindorm.
Titik akhir yang benar tidak digunakan.	Lindorm menyediakan titik akhir berbeda untuk akses VPC dan akses jaringan publik. Pastikan Anda menggunakan titik akhir yang sesuai dengan lingkungan jaringan Anda.

Jika masalah tetap berlanjut, hubungi dukungan teknis Lindorm di DingTalk. ID DingTalk-nya adalah s0s3eg3.

Referensi

Untuk informasi selengkapnya tentang sintaks SQL tabel lebar Lindorm, lihat Referensi SQL.
Untuk metode koneksi lainnya, lihat Hubungkan ke dan gunakan LindormTable menggunakan baris perintah MySQL dan Gunakan protokol MySQL (Direkomendasikan).