Panduan memulai menggunakan Spanner Omni CLI

Dokumen ini menunjukkan cara menggunakan antarmuka command line (CLI) Spanner Omni untuk berinteraksi dengan dan mengelola deployment Spanner Omni. CLI Spanner Omni menyediakan perintah untuk tugas administratif umum dan menyertakan shell SQL interaktif untuk mengkueri database Anda.

Sebelum memulai

Sebelum dapat menggunakan Spanner Omni CLI, pastikan Anda memenuhi persyaratan berikut:

  1. Deployment Spanner Omni disiapkan dan berjalan.
  2. Mesin yang menjalankan Spanner Omni CLI memiliki akses jaringan ke load balancer deployment Spanner Omni atau ke setidaknya salah satu server dalam deployment.

Langkah 1: Download dan instal Spanner Omni CLI

  1. Download Spanner Omni CLI dari bucket Cloud Storage spanner-omni.

    Buka bucket Spanner Omni

  2. Ekstrak file tar.

    tar -xvf CLI_TAR_FILE
    

    Perintah ini akan menginstal biner Spanner Omni CLI, yang disebut spanner, di direktori google/spanner/bin.

    Untuk menjalankan perintah spanner, tambahkan direktori google/spanner/bin ke variabel lingkungan PATH Anda, atau gunakan jalur lengkap ke biner dalam langkah-langkah berikut.

Langkah 2: Hubungkan ke deployment Anda

Secara default, Spanner Omni CLI mencoba terhubung ke localhost:15000. Untuk terhubung ke deployment tertentu, gunakan flag --deployment-endpoint.

Misalnya, perintah berikut mencantumkan zona dalam deployment Anda:

spanner deployment zones list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Langkah 3: Jalankan perintah umum

Berikut adalah perintah administratif umum yang dapat Anda jalankan dengan Spanner Omni CLI.

Dapatkan bantuan

Untuk melihat daftar perintah dan flag global yang tersedia, jalankan:

spanner --help

Buat database

Untuk membuat database baru di deployment Anda, jalankan:

spanner databases create DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Mencantumkan semua database

Untuk mencantumkan semua database dalam deployment Anda, jalankan:

spanner databases list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Langkah 4: Mulai sesi shell SQL interaktif

Spanner Omni CLI menyertakan shell SQL interaktif untuk menjalankan kueri. Dengan memulai shell untuk database tertentu menggunakan tanda --database, Anda dapat menjalankan perintah SQL tanpa perlu menentukan database atau endpoint untuk setiap kueri.

Untuk memulai shell SQL, jalankan:

spanner sql --database=DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Setelah shell dimulai, Anda akan melihat perintah sql>:

spanner-cli>

Untuk keluar dari shell, ketik exit.