すべてのプロダクト
Search
ドキュメントセンター

Lindorm:Lindorm-cli を使用したワイドテーブルエンジンへの接続と利用

最終更新日:Jul 15, 2026

Lindorm-cli は、Lindorm が提供する、Lindorm データベースへの接続と管理を行うための軽量なコマンドラインインターフェイス (CLI) です。Lindorm-cli を使用して、テーブルの作成、データのクエリ、データの書き込み、データのエクスポートなどの基本的な SQL 操作を実行できます。このトピックでは、Lindorm-cli を使用して Lindorm ワイドテーブルエンジンに接続し、使用する方法について説明します。

前提条件

lindorm-cli を実行する環境をクライアント環境と定義します。lindorm-cli を使用して Lindorm ワイドテーブルエンジンにアクセスする前に、以下を確認してください。

  • クライアントの IP アドレスを Lindorm のホワイトリストに追加します。詳細については、「ホワイトリストの設定」をご参照ください。

  • クライアント環境と Lindorm 間のネットワークタイプを決定します。

    lindorm-cli を使用してワイドテーブルエンジンに接続する場合、以下のネットワークタイプがサポートされています。

    ネットワークタイプ

    説明

    VPC (Virtual Private Cloud) (推奨)

    VPC (Virtual Private Cloud) は、クラウド上のプライベートネットワークです。異なる VPC はレイヤー 2 論理分離で分離されており、高いセキュリティを提供します。lindorm-cli を Elastic Compute Service (ECS) インスタンスにデプロイする場合、VPC 経由で Lindorm ワイドテーブルエンジンに接続すると、より高いセキュリティと低いネットワーク遅延が実現します。

    パブリックネットワーク

    パブリックネットワークとはインターネットのことです。オンプレミスデバイスから Lindorm ワイドテーブルエンジンをテストまたは管理する必要がある場合は、lindorm-cli をローカルデバイスにデプロイし、パブリックネットワーク経由で Lindorm ワイドテーブルエンジンに接続します。

    説明
    • パブリックネットワーク経由の接続ではトラフィック料金は発生しませんが、セキュリティリスクが伴います。より高いセキュリティを確保するために、VPC の使用を推奨します。

    • コンソールでパブリックエンドポイントを有効にする必要があります。詳細については、「操作手順」をご参照ください。

インストール

  1. お使いのオペレーティングシステムに対応する Lindorm-cli インストールパッケージをダウンロードします。ダウンロードリンクは次の表に記載されています。

    説明

    表内の SHA256 チェックサムは、ダウンロードした Lindorm-cli パッケージの整合性と信頼性を検証するために使用できます。

    オペレーティングシステム

    ダウンロードリンク

    SHA256 チェックサム

    Linux

    lindorm-cli for linux

    直接ダウンロードコマンド:

    wget https://tsdbtools.oss-cn-hangzhou.aliyuncs.com/lindorm-cli-linux-latest.tar.gz

    3a9ee33e24769cf47b3a90c3a1bba29d26f8aede7a64dbc13ea1f4f5426f04e4

    Linux-arm64

    lindorm-cli for linux-arm64

    直接ダウンロードコマンド:

    wget https://tsdbtools.oss-cn-hangzhou.aliyuncs.com/lindorm-cli-linux-arm64-latest.tar.gz

    bc723d4a3a14a85c973c7082a56bb4934a40d2b9cccd72b5767352b8c334ce19

    Mac (Intel チップ)

    lindorm-cli for mac

    34efd3f43a700e1fea72ee5e5933b9df3cf624569bcf59a2f8a6752dc7faab6c

    Mac (Arm チップ)

    lindorm-cli for mac

    0be9b346404a37d953714377b59f06b6492ff9c4e46dba4d5bf07c390ee284ad

    Windows

    lindorm-cli for windows-x64

    54a447f263b93b158533f7ccd542cbf52e42fb66ce287d38065a798b7801fc48

  2. Lindorm-cli パッケージを解凍します。

    お使いのオペレーティングシステムの標準的な解凍方法を使用して、ダウンロードしたパッケージを展開します。

    Linux の場合は、次のコマンドを実行してパッケージを解凍します。解凍後、lindorm-cli ファイルが生成されます。この実行可能ファイルは、追加のインストール手順なしでシェルターミナルで直接実行できます。

    tar zxvf lindorm-cli-linux-latest.tar.gz

接続方法

Lindorm-cli は、MySQL プロトコルまたは Avatica プロトコルのいずれかを使用して Lindorm ワイドテーブルエンジンに接続することをサポートしています。MySQL プロトコルの使用を推奨します。

重要

lindorm-cli バージョン 2.0.0 以降のみが、MySQL プロトコルを使用したワイドテーブルエンジンへの接続をサポートしています。

MySQL プロトコルを使用したワイドテーブルエンジンへの接続 (推奨)

Linux または Mac にデプロイされたクライアント

  1. Lindorm-cli を含むディレクトリに移動します。

    cd <Lindorm-cli directory>
  2. 次のコマンドを実行して、ワイドテーブルエンジンに接続します。

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

    パラメーターの説明

    パラメーター

    説明

    mysql url

    Lindorm ワイドテーブルエンジンのMySQL 互換エンドポイントです。接続設定の詳細については、「接続設定」をご参照ください。

    username

    Lindorm ワイドテーブルエンジンに接続するためのユーザー名です。

    password

    Lindorm ワイドテーブルエンジンに接続するためのパスワードです。

    重要
    • パスワードを忘れた場合は、Lindorm ワイドテーブルエンジンのクラスター管理システムでユーザーパスワードをリセットできます。

    • パスワードをリセットした後、コンソールでエンジンを再起動してください。

    接続設定

    サポートされる接続設定

    説明

    mysql:// プロトコルヘッダー

    mysql url の前に mysql:// プロトコルヘッダーを追加できます。

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

    サーバーサイドのカスタム接続パラメーター

    mysql urlkey1=value1&key2=value2 の形式でサーバーサイドのカスタム接続パラメーターを追加できます。

    現在、以下のパラメーターがサポートされています。

    operationTimeout: クエリタイムアウト期間を指定します。形式は <mysql url>?operationTimeout=<timeout> で、タイムアウトの単位はミリ秒 (ms) です。例: ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000

    重要

    ワイドテーブルエンジンのバージョン 2.7.7 以降のみが operationTimeout パラメーターをサポートしています。現在のバージョンの確認またはアップグレード方法については、「ワイドテーブルエンジンのバージョンガイド」および「マイナーバージョンアップ」をご参照ください。

    接続例

    ./lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --mysql:// プロトコルヘッダーを追加
    ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --クエリタイムアウトを指定
    ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

    接続が成功すると、次の結果が返されます。

    lindorm-cli version: 2.0.x

    ここで、2.0.x は Lindorm-cli のバージョン番号です。

Windows にデプロイされたクライアント

方法 1
  1. コマンドプロンプト (CMD) を開き、lindorm-cli.exe を含むディレクトリに移動します。

    cd <lindorm-cli.exe directory>
  2. CMD で次のコマンドを実行して、ワイドテーブルエンジンに接続します。

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

    パラメーターの説明

    パラメーター

    値の例

    取得方法

    mysql url

    ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060

    Lindorm ワイドテーブルエンジンのMySQL 互換エンドポイントです。接続設定の詳細については、「接続設定」をご参照ください。

    username

    user

    Lindorm ワイドテーブルエンジンに接続するためのユーザー名です。

    password

    test

    Lindorm ワイドテーブルエンジンに接続するためのパスワードです。

    重要
    • パスワードを忘れた場合は、Lindorm ワイドテーブルエンジンのクラスター管理システムでユーザーパスワードをリセットできます。

    • パスワードをリセットした後、コンソールでエンジンを再起動してください。

    接続設定

    サポートされる接続設定

    説明

    mysql:// プロトコルヘッダー

    mysql url の前に mysql:// プロトコルヘッダーを追加できます。

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

    サーバーサイドのカスタム接続パラメーター

    mysql urlkey1=value1&key2=value2 の形式でサーバーサイドのカスタム接続パラメーターを追加できます。

    サポートされているパラメーターは次のとおりです。

    operationTimeout: クエリタイムアウト期間を指定します。形式は <mysql url>?operationTimeout=<timeout> で、タイムアウトの単位はミリ秒 (ms) です。例: ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000

    重要

    ワイドテーブルエンジンのバージョン 2.7.7 以降のみが operationTimeout パラメーターをサポートしています。現在のバージョンの確認またはアップグレード方法については、「ワイドテーブルエンジンのバージョンガイド」および「マイナーバージョンアップ」をご参照ください。

    接続例

    lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --mysql:// プロトコルヘッダーを追加
    lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --クエリタイムアウトを指定
    lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

    接続が成功すると、次の結果が返されます。

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

    ここで、2.0.x は Lindorm-cli のバージョン番号です。

方法 2

Lindorm-cli.exe プログラムをダブルクリックして開き、次のコマンドを実行します。

connect <mysql url> <username> <password>

接続例

connect ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:33060  user test

接続が成功しても出力はありません。

Avatica プロトコルを使用したワイドテーブルエンジンへの接続

Linux または Mac にデプロイされたクライアント

  1. Lindorm-cli を含むディレクトリに移動します。

    cd <Lindorm-cli directory>
  2. 次のコマンドを実行して、ワイドテーブルエンジンに接続します。

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

    パラメーターの説明

    パラメーター

    値の例

    取得方法

    jdbc url

    jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060

    Lindorm ワイドテーブルエンジンのワイドテーブル SQL エンドポイントです。

    username

    user

    Lindorm ワイドテーブルエンジンに接続するためのユーザー名です。

    password

    test

    Lindorm ワイドテーブルエンジンに接続するためのパスワードです。

    重要
    • パスワードを忘れた場合は、Lindorm ワイドテーブルエンジンのクラスター管理システムでユーザーパスワードをリセットできます。

    • パスワードをリセットした後、コンソールでエンジンを再起動してください。

    接続例

    ./lindorm-cli -url jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060 -username user -password test

    接続が成功すると、次の結果が返されます。

    lindorm-cli version: 2.0.xx

    ここで、2.0.xx は Lindorm-cli のバージョン番号です。

Windows にデプロイされたクライアント

方法 1
  1. コマンドプロンプト (CMD) を開き、lindorm-cli.exe を含むディレクトリに移動します。

    cd <lindorm-cli.exe directory>
  2. CMD で次のコマンドを実行して、ワイドテーブルエンジンに接続します。

    lindorm-cli -url <jdbc url> -username <username> -password <password>

    パラメーターの説明

    パラメーター

    値の例

    取得方法

    jdbc url

    jdbc:lindorm:table:url=http://ld-bp17j28j2y7pm****-proxy-lindorm-pub.lindorm.rds.aliyuncs.com:30060

    Lindorm ワイドテーブルエンジンのワイドテーブル SQL エンドポイントです。

    username

    user

    Lindorm ワイドテーブルエンジンに接続するためのユーザー名です。

    password

    test

    Lindorm ワイドテーブルエンジンに接続するためのパスワードです。

    重要
    • パスワードを忘れた場合は、Lindorm ワイドテーブルエンジンのクラスター管理システムでユーザーパスワードをリセットできます。

    • パスワードをリセットした後、コンソールでエンジンを再起動してください。

    接続例

    lindorm-cli -url jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:30060 -username user -password test

    接続が成功すると、次の結果が返されます。

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

    ここで、2.0.xx は Lindorm-cli のバージョン番号です。

方法 2

Lindorm-cli.exe プログラムをダブルクリックして開き、次のコマンドを実行します。

connect <jdbc url> <username> <password>

接続例

connect jdbc:lindorm:table:url=http://ld-bp13y790c91f4****-proxy-lindorm-pub.lindorm.aliyuncs.com:30060 user test

接続が成功しても出力はありません。

使用方法

Lindorm-cli は、インタラクティブモードと非インタラクティブモードの両方をサポートしており、ワイドテーブルエンジンに対して SQL ステートメントを実行できます。

インタラクティブモードでの SQL ステートメントの実行

ほとんどの場合、インタラクティブモードで lindorm-cli を起動してワイドテーブルエンジンを操作します。ワークフローは次のとおりです。

  1. lindorm-cli の起動
    前のセクションで説明したいずれかのプロトコルを使用して Lindorm ワイドテーブルエンジンに接続すると、ターミナルは lindorm-cli のインタラクティブインターフェイスに入り、さらなるコマンドを待機します。

    説明

    Windows では、lindorm-cli.exe をダブルクリックすると CMD ターミナルウィンドウが開きます。これにより lindorm-cli のインタラクティブインターフェイスが起動しますが、Lindorm ワイドテーブルエンジンへの接続は確立されません。SQL ステートメントを実行する前に、connect サブコマンドを使用して接続を確立する必要があります。詳細については、「Windows にデプロイされたクライアント」および「方法 2」をご参照ください。

  2. ワイドテーブルエンジンにアクセスするための SQL ステートメントの入力
    接続を確立してインタラクティブインターフェイスに入った後、SQL ステートメントを入力してワイドテーブルエンジンにアクセスします。サポートされている SQL 構文については、「SQL リファレンス」をご参照ください。

  3. lindorm-cli の終了
    インタラクティブインターフェイスでの操作が完了したら、exit サブコマンドを実行するか、キーボードショートカットの ctrl+d を押して lindorm-cli を終了します。

説明

インタラクティブモードで lindorm-cli を起動し、ワイドテーブルエンジンへの接続に成功すると、クライアントは終了するまでエンジンとのセッションを維持します。この期間中のすべての SQL 操作は同じセッションで実行されます。セッションが長時間アイドル状態になると、システムはリソースを解放するために自動的に切断されることにご注意ください。

非インタラクティブモードでの SQL ステートメントの実行

O&M スクリプトを作成する際に、インタラクティブなコマンドラインに入らずに直接 Lindorm SQL ステートメントを実行したい場合は、lindorm-cli の非インタラクティブモードを使用して LindormTable を操作できます。このモードは、コマンドパラメーターを介して直接 SQL を実行し、結果を返すため、クエリや統計操作の実行などの自動化タスクに適しています。

シェルターミナルから非インタラクティブモードで SQL ステートメントを実行するには、「接続方法」で説明されている接続パラメーター (ホストアドレスやポートなど) に、-execute パラメーターと、シングルクォートまたはダブルクォートで囲んだ SQL ステートメントを追加します。これにより、短時間接続が迅速に確立され、コマンドが実行されます。例:

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

非インタラクティブモードを使用して、ワイドテーブルのクエリ結果を CSV ファイルにエクスポートすることもできます。

重要

CSV へのエクスポートには、lindorm-cli バージョン 2.2.0 以降が必要です。現在のバージョンを確認するには:

  • コマンドラインで lindorm-cli -version を実行します。

  • インタラクティブモードに入るときのウェルカムメッセージに表示されるバージョンを確認します。

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;"
説明
  • 短時間接続:非インタラクティブモードでは、lindorm-cli は SQL ステートメントごとに新しい接続を確立し、実行直後にそれを閉じます。

  • 出力制御:結果はデフォルトでターミナル画面 (stdout) に出力されます。出力をファイルにリダイレクトするには、-output パラメーターを使用します。

AI エージェントと lindorm-cli の連携

インタラクティブモードと非インタラクティブモードに加えて、lindorm-cli は AI エージェントによって呼び出すこともできます。自然言語を使用して AI エージェントに Lindorm のデータクエリ、結果分析、または O&M スクリプト生成を自動的に実行させたい場合は、Lindorm Agent Skill と lindorm-cli を組み合わせることができます。

説明

以下で説明する AI エージェント向けの機能には、lindorm-cli バージョン 2.3.0 以降が必要です。

利用シーン

AI エージェントを介して lindorm-cli を使用することは、次のシナリオに適しています。

  • 自然言語によるデータクエリ:クエリの意図を自然言語で記述します。エージェントは SQL ステートメントを生成・実行し、構造化された結果を返します。

  • バッチ O&M スクリプトの生成:定期タスクやバッチデータ処理の要件に基づいて、エージェントに lindorm-cli を呼び出すスクリプトを生成させます。

  • 構造化された結果のエクスポート:エージェントを使用して、クエリ結果を機械が解析可能な形式 (JSON や JSONL など) で直接エクスポートし、下流の処理に利用します。

Lindorm Agent Skill のインストール

Lindorm Agent Skill は、AI エージェントに lindorm-cli を呼び出すために必要なコンテキストを提供します。エージェントがローカルの lindorm-cli インストールを自動的に検出し、適切なパラメーターを選択し、コマンドを構築するのをガイドします。

Lindorm Agent Skill はこちらからダウンロードできます: alibabacloud-lindorm-agent-skill

インストール後、エージェントは会話の中で直接 lindorm-cli を呼び出して Lindorm ワイドテーブルエンジンにアクセスできます。この Skill には、後述する CLI の機能とパラメーターが組み込まれているため、通常、これらのパラメーターを手動で入力する必要はありません。

エージェントの使用方法

Lindorm Agent Skill をインストールした後、要件を自然言語で記述するだけで済みます。エージェントは Skill のガイダンスの下で、検出、クエリ、セキュリティ制御、認証情報の注入を自動的に実行します。

エージェントによる lindorm-cli 機能の自動検出

最初の呼び出しの前に、エージェントは現在の環境における lindorm-cli のバージョン、サポートされているプロトコル、出力形式、および終了コードの定義を検出します。これにより、エージェントはハードコーディングされた仮定に頼るのではなく、実際の環境に基づいて正しい呼び出し方法を選択できます。

説明

この動作は Lindorm Agent Skill に組み込まれており、lindorm-cli の --capabilities パラメーターに対応します。

エージェントによる構造化フォーマットでの結果返却

エージェントがクエリを実行する際、lindorm-cli に JSON または JSONL 形式で結果を出力するよう要求します。クエリ結果データのみが stdout に送信され、ステータスメッセージと警告は stderr に送られます。2つのストリームは分離されており、エージェントによる解析が容易になります。

大きな結果セットの場合、エージェントは JSONL 形式を使用して結果を一行ずつ消費し、一度にすべてのデータをロードすることを回避します。

説明

この動作は Lindorm Agent Skill に組み込まれており、lindorm-cli の -format json および -format jsonl パラメーターに対応します。

エージェントによるセーフティガードレールの有効化

Lindorm Agent Skill はデフォルトでセーフモードを有効にし、DROP TABLE、TRUNCATE TABLE、DELETE FROM などの高リスクの書き込み操作をクライアント側でインターセプトして、エージェントが誤って破壊的な SQL を実行するのを防ぎます。Skill はまた、クエリごとに返される最大行数を制限し、大きな結果セットがエージェントのコンテキストウィンドウを使い果たすのを防ぎます。

説明

この動作は Lindorm Agent Skill に組み込まれており、lindorm-cli の --safe-mode および --max-rows パラメーターに対応します。

エージェントによる安全な認証情報の注入

エージェントが lindorm-cli を呼び出す際、Skill は環境変数または標準入力を介してユーザー名とパスワードを注入することを優先し、認証情報がコマンドライン引数、シェル履歴、またはプロセスリストに表示されるのを防ぎます。

説明

この動作は Lindorm Agent Skill に組み込まれており、環境変数による認証情報の注入と lindorm-cli の --password-stdin パラメーターに対応します。

コマンドラインパラメーターとサブコマンド

コマンドラインパラメーター

ターミナルで lindorm-cli を起動する際に、次のコマンドラインパラメーターを指定できます。

パラメーター名

値は必須

説明

url

はい

Lindorm ワイドテーブルエンジンのプロトコル名 + SQL 接続文字列 (ポートを含む)

lindorm-cli がワイドテーブルエンジンに接続するためのプロトコルと接続文字列を指定します。

username

はい

接続用のユーザー名

指定されたユーザー名は、ワイドテーブルエンジンで既に作成されている Lindorm ユーザーである必要があります。

password

はい

ユーザー名のパスワード

-

database

はい

接続するデータベース名

指定しない場合、デフォルトのデータベースが使用されます。指定した場合、データベースはワイドテーブルエンジンに既に存在している必要があります。

execute

はい

実行する SQL ステートメント

execute パラメーターが指定されると、lindorm-cli は非インタラクティブモードで実行されます。SQL ステートメントをシングルクォートまたはダブルクォートで囲みます。

説明

SQL ステートメントをダブルクォートで囲む場合、内部のダブルクォートはバックスラッシュ \ でエスケープしてください。シングルクォートはエスケープをサポートしていません。

output

はい

非インタラクティブモードでの SQL 実行結果の出力先

非インタラクティブモードで output が指定されていない場合、結果は標準出力に出力されます。指定されている場合、結果は指定されたパスのファイルに書き込まれます。ファイルが存在しない場合は作成されます。

format

はい

次のいずれか:

horizontal, vertical, csv, json, column

ワイドテーブルエンジンから返される SQL 実行結果のフォーマットを変更します。デフォルトのフォーマットは column です。

  • column:一般的なテーブル形式で結果を表示します。

  • horizontal:データを列ごとに水平に表示します。

  • vertical:データを MySQL コマンドラインの \G フォーマットと同様に、行ごとに垂直に表示します。

  • csv:結果をテーブルの罫線なしで CSV 形式で表示します。

  • json:結果を JSON 形式で表示します。

pretty

いいえ

-

format が JSON に設定されている場合に使用します。

有効にすると、結果は整形された JSON として出力されます。デフォルトでは、結果はコンパクトな JSON として出力されます。

csvNoHeader

いいえ

-

format が CSV に設定されている場合に使用します。

有効にすると、結果は列ヘッダーなしの CSV 形式で出力されます。

nullString

はい

NULL 値を置き換える文字列

format が CSV に設定されている場合に使用します。

指定すると、クエリ結果の NULL 値が指定された文字列に置き換えられます。

nullString が指定されていない場合、NULL 値は次のように出力されます。

  • MySQL プロトコル経由で接続した場合、NULL 値は \N として表現されます。

  • Avatica プロトコル経由で接続した場合、NULL 値は空の文字列として表現されます。

version

いいえ

-

lindorm-cli のバージョン情報を表示します。このパラメーターを使用すると、lindorm-cli は起動せず、インタラクティブモードにも入りません。

format

はい

次のいずれか:horizontal, vertical, csv, json, jsonl, column

ワイドテーブルエンジンから返される SQL 実行結果のフォーマットを変更します。デフォルトは column です。

  • column:結果を標準テーブル形式で表示します。

  • horizontal:データを列ごとに水平に表示します。

  • vertical: 行単位でデータを縦に表示します。

  • csv:結果をテーブルの罫線なしで CSV 形式で表示します。

  • json:エージェントが解析するために結果を JSON 形式で表示します。

  • jsonl:1行に1つの独立した JSON オブジェクト。エージェントが大きな結果セットをストリーミング方式で消費するのに適しています。

capabilities

いいえ

-

lindorm-cli の JSON 機能宣言を出力します。これには、サポートされているエンジン、フォーマット、終了コード、パラメーターが含まれます。AI エージェントのシナリオでは、これは Lindorm Agent Skill によって自動的に呼び出されます。

safe-mode

いいえ

-

有効にすると、クライアントは DROP TABLE、TRUNCATE TABLE、DELETE FROM などの高リスクの書き込み操作をインターセプトします。AI エージェントのシナリオでは、これは Lindorm Agent Skill によってデフォルトで有効になります。

max-rows

はい

正の整数

クライアントから返される最大行数を制限します。超過した行は切り捨てられます。AI エージェントのシナリオでは、大きな結果セットがエージェントのコンテキストウィンドウを使い果たすのを防ぐために、Lindorm Agent Skill によってデフォルトで設定されます。

password-stdin

いいえ

-

パスワードがコマンドライン引数に表示されるのを防ぐために、標準入力からパスワードを読み取ります。AI エージェントのシナリオでは、Lindorm Agent Skill は平文の -password パラメーターよりもこちらを優先します。

説明

すべての lindorm-cli コマンドラインパラメーターには、ハイフン - をプレフィックスとして付ける必要があります。

一般的なサブコマンド

インタラクティブモードで lindorm-cli を起動した後、インタラクティブインターフェイスで lindorm-cli サブコマンドを実行してその動作を制御できます。これに加えて、Lindorm ワイドテーブルエンジンに SQL ステートメントを送信することもできます。一般的なサブコマンドは以下のとおりです。

サブコマンド

パラメーター

説明

connect

<url> <username> <password>

lindorm-cli が接続なしでインタラクティブモードで起動された場合、connect サブコマンドを使用して Lindorm ワイドテーブルエンジンへの接続を確立します。

url、username、および password パラメーターは、コマンドラインパラメーターの urlusername、および password と同じ意味を持ちます。

format

次のいずれか:

horizontal, vertical, csv, json

format パラメーターと同じです。

help

なし

一般的なサブコマンドのリストを表示します。

history

なし

最近実行された SQL ステートメントまたはサブコマンドを表示します。

exit または quit

なし

lindorm-cli を終了し、Lindorm ワイドテーブルエンジンから切断します。

よくある質問

接続タイムアウトや接続失敗が発生する原因

接続タイムアウトや接続失敗は、Failed to connect to <wide table endpoint> connection check failedconnection timeout などのエラーを返します。

考えられる原因と解決策は以下のとおりです。順番に確認してください。

原因

解決策

パブリックネットワーク接続を使用しているが、パブリック IP アドレスがホワイトリストに追加されていない。

クライアントのパブリック IP アドレスを Lindorm のホワイトリストに追加します

クライアントのパブリック IP アドレスを見つけるには、Windows のコマンドプロンプト (CMD) で curl ipinfo.io/ip または curl ifconfig.me を実行します。

パブリック IP アドレスはホワイトリストに追加されているが、接続タイムアウトが続く。

ネットワークの不安定性が原因である可能性があります。VPC 接続に切り替えることを推奨します。

ECS インスタンスからアクセスしているが、ECS の IP アドレスが Lindorm のホワイトリストに追加されていない。

ECS の IP アドレスを取得し、それを Lindorm のホワイトリストに追加します

不正なエンドポイントを使用している。

Lindorm のエンドポイントは、VPC 接続とパブリックネットワーク接続で異なります。ご利用のネットワーク環境に基づいて正しいエンドポイントを使用してください。

これらの解決策で問題が解決しない場合は、Lindorm のテクニカルサポート (DingTalk ID: s0s3eg3) にお問い合わせください。

参考資料