Todos os produtos
Search
Central de documentação

Lindorm:Conectar e usar o mecanismo de tabela larga com o Lindorm-cli

Última atualização: Aug 31, 2026

O Lindorm-cli é uma interface de linha de comando (CLI) leve fornecida pelo Lindorm para conexão e gerenciamento de bancos de dados Lindorm. Use o Lindorm-cli para executar operações SQL básicas, como criação de tabelas, consulta, escrita e exportação de dados. Este tópico descreve como se conectar e usar o mecanismo de tabela larga do Lindorm com o Lindorm-cli.

Pré-requisitos

O ambiente onde você executa o lindorm-cli é definido como ambiente cliente. Antes de usar o lindorm-cli para acessar o mecanismo de tabela larga do Lindorm, confirme os seguintes itens:

  • Adicione o endereço IP do cliente à lista de permissões do Lindorm. Para mais informações, consulte Configure a whitelist.

  • Determine o tipo de rede entre o ambiente cliente e o Lindorm.

    Os seguintes tipos de rede são suportados ao conectar-se ao mecanismo de tabela larga com o lindorm-cli:

    Tipo de rede

    Descrição

    Virtual private cloud (VPC) (recomendado)

    Uma Virtual Private Cloud (VPC) é sua rede privada na nuvem. Diferentes VPCs possuem isolamento lógico na camada 2, oferecendo alta segurança. Ao implantar o lindorm-cli em uma instância ECS, a conexão com o mecanismo de tabela larga do Lindorm via VPC proporciona maior segurança e menor latência de rede.

    Rede pública

    A rede pública refere-se à Internet. Quando for necessário testar ou gerenciar o mecanismo de tabela larga do Lindorm a partir de um dispositivo local, implante o lindorm-cli nesse dispositivo e conecte-se ao mecanismo pela rede pública.

    Nota
    • A conexão via rede pública não gera taxas de tráfego, mas apresenta riscos de segurança. Recomendamos o uso de uma VPC para maior proteção.

    • É necessário ativar o endpoint público no console. Para mais informações, consulte Procedure.

Instalação

  1. Baixe o pacote de instalação do Lindorm-cli compatível com seu sistema operacional. Os links para download estão listados na tabela a seguir.

    Nota

    As somas de verificação SHA256 na tabela servem para validar a integridade e autenticidade dos pacotes baixados do Lindorm-cli.

    Sistema operacional

    Link para download

    Soma de verificação SHA256

    Linux

    lindorm-cli para linux

    Comando para download direto:

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

    fdd0cdece2a3d29124dd9538edefdd66532b950653f049d6b4fd6a21cb2cd6fc

    Linux-arm64

    lindorm-cli para linux-arm64

    Comando para download direto:

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

    bd602405a2e988cf77d6b3afa2aac35ce72b437038119f4b3a9d926d3ffb5be1

    Mac (chip Intel)

    lindorm-cli para mac

    cfff2a661fe6d48e0d55dbfca149847a3b8c0ef391d59e4694a425a22a44f5be

    Mac (chip Arm)

    lindorm-cli para mac

    1aae53cf83ad40a7386ea5711684d733e9728566c3f7463d00070a56201b79dc

    Windows

    lindorm-cli para windows-x64

    cf2330fac41cc3d731282cd8dddfd5656ad05c1f8e1113607cf427d0614b23b6

  2. Descompacte o pacote do Lindorm-cli.

    Use o método padrão de descompactação do seu sistema operacional para extrair o pacote baixado.

    No Linux, execute o comando abaixo para descompactar o pacote. Após a extração, você obterá o arquivo lindorm-cli. Esse executável pode ser executado diretamente em um terminal shell sem etapas adicionais de instalação.

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

Métodos de conexão

O Lindorm-cli suporta conexão com o mecanismo de tabela larga do Lindorm através dos protocolos MySQL, Avatica ou nativo do HBase. Recomendamos o uso do protocolo MySQL.

Importante

Somente versões do lindorm-cli 2.0.0 e posteriores suportam conexão com o mecanismo de tabela larga via protocolo MySQL.

Somente versões do lindorm-cli 2.4.0 e posteriores suportam conexão com o mecanismo de tabela larga via protocolo HBase.

Conectar ao mecanismo de tabela larga usando o protocolo MySQL (recomendado)

Cliente implantado em Linux ou Mac

  1. Acesse o diretório que contém o Lindorm-cli.

    cd <Lindorm-cli directory>
  2. Execute o comando a seguir para se conectar ao mecanismo de tabela larga.

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

    Descrição dos parâmetros

    Parâmetro

    Descrição

    mysql url

    O endpoint compatível com MySQL do mecanismo de tabela larga do Lindorm. Para mais detalhes sobre configurações de conexão, consulte Configuração de conexão.

    username

    O nome de usuário para conexão com o mecanismo de tabela larga do Lindorm.

    password

    A senha para conexão com o mecanismo de tabela larga do Lindorm.

    Importante
    • Caso tenha esquecido a senha, você pode redefinir a senha do usuário no sistema de gerenciamento de cluster do mecanismo de tabela larga do Lindorm.

    • Após redefinir a senha, reinicie o mecanismo no console.

    Configuração de conexão

    Configurações de conexão suportadas

    Descrição

    Cabeçalho de protocolo mysql://

    É possível adicionar o cabeçalho de protocolo mysql:// antes da mysql url.

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

    Parâmetros de conexão personalizados do lado do servidor

    Você pode anexar parâmetros de conexão personalizados do servidor à mysql url no formato key1=value1&key2=value2.

    Atualmente, o seguinte parâmetro é suportado:

    operationTimeout: Define o tempo limite da consulta. O formato é <mysql url>?operationTimeout=<timeout>, onde a unidade de tempo é milissegundos (ms). Exemplo: ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000.

    Importante

    Apenas versões do mecanismo de tabela larga 2.7.7 e posteriores suportam o parâmetro operationTimeout. Para saber como visualizar ou atualizar sua versão atual, consulte Guia de versão do mecanismo de tabela larga e Atualização de versão secundária.

    Exemplos de conexão

    ./lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --Add mysql:// protocol header
    ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --Specify query timeout
    ./lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

    Uma conexão bem-sucedida retorna o seguinte resultado:

    lindorm-cli version: 2.0.x

    Neste caso, 2.0.x representa o número da versão do Lindorm-cli.

Cliente implantado em Windows

Método 1
  1. Abra o Prompt de Comando (CMD) e acesse o diretório que contém o lindorm-cli.exe.

    cd <lindorm-cli.exe directory>
  2. Execute o comando abaixo no CMD para se conectar ao mecanismo de tabela larga.

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

    Descrição dos parâmetros

    Parâmetro

    Valor de exemplo

    Como obter

    mysql url

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

    O endpoint compatível com MySQL do mecanismo de tabela larga do Lindorm. Para mais detalhes sobre configurações de conexão, consulte Configuração de conexão.

    username

    user

    O nome de usuário para conexão com o mecanismo de tabela larga do Lindorm.

    password

    test

    A senha para conexão com o mecanismo de tabela larga do Lindorm.

    Importante
    • Caso tenha esquecido a senha, você pode redefinir a senha do usuário no sistema de gerenciamento de cluster do mecanismo de tabela larga do Lindorm.

    • Após redefinir a senha, reinicie o mecanismo no console.

    Configuração de conexão

    Configurações de conexão suportadas

    Descrição

    Cabeçalho de protocolo mysql://

    É possível adicionar o cabeçalho de protocolo mysql:// antes da mysql url.

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

    Parâmetros de conexão personalizados do lado do servidor

    Você pode anexar parâmetros de conexão personalizados do servidor à mysql url no formato key1=value1&key2=value2.

    Os parâmetros suportados são:

    operationTimeout: Define o tempo limite da consulta. O formato é <mysql url>?operationTimeout=<timeout>, onde a unidade de tempo é milissegundos (ms). Exemplo: ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000.

    Importante

    Apenas versões do mecanismo de tabela larga 2.7.7 e posteriores suportam o parâmetro operationTimeout. Para saber como visualizar ou atualizar sua versão atual, consulte Guia de versão do mecanismo de tabela larga e Atualização de versão secundária.

    Exemplos de conexão

    lindorm-cli -url ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --Add mysql:// protocol header
    lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060 -username user -password test
    
    --Specify query timeout
    lindorm-cli -url mysql://ld-bp187uwcx5f40****-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060?operationTimeout=120000 -username user -password test

    Uma conexão bem-sucedida retorna o seguinte resultado:

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

    Neste caso, 2.0.x representa o número da versão do Lindorm-cli.

Método 2

Clique duas vezes para abrir o programa Lindorm-cli.exe e execute o seguinte comando:

connect <mysql url> <username> <password>

Exemplo de conexão

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

Uma conexão bem-sucedida não gera saída no terminal.

Conectar ao mecanismo de tabela larga usando o protocolo Avatica

Cliente implantado em Linux ou Mac

  1. Acesse o diretório que contém o Lindorm-cli.

    cd <Lindorm-cli directory>
  2. Execute o comando a seguir para se conectar ao mecanismo de tabela larga.

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

    Descrição dos parâmetros

    Parâmetro

    Valor de exemplo

    Como obter

    jdbc url

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

    O endpoint SQL da tabela larga do mecanismo de tabela larga do Lindorm.

    username

    user

    O nome de usuário para conexão com o mecanismo de tabela larga do Lindorm.

    password

    test

    A senha para conexão com o mecanismo de tabela larga do Lindorm.

    Importante
    • Caso tenha esquecido a senha, você pode redefinir a senha do usuário no sistema de gerenciamento de cluster do mecanismo de tabela larga do Lindorm.

    • Após redefinir a senha, reinicie o mecanismo no console.

    Exemplo de conexão

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

    Uma conexão bem-sucedida retorna o seguinte resultado:

    lindorm-cli version: 2.0.xx

    Neste caso, 2.0.xx representa o número da versão do Lindorm-cli.

Cliente implantado em Windows

Método 1
  1. Abra o Prompt de Comando (CMD) e acesse o diretório que contém o lindorm-cli.exe.

    cd <lindorm-cli.exe directory>
  2. Execute o comando abaixo no CMD para se conectar ao mecanismo de tabela larga.

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

    Descrição dos parâmetros

    Parâmetro

    Valor de exemplo

    Como obter

    jdbc url

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

    O endpoint SQL da tabela larga do mecanismo de tabela larga do Lindorm.

    username

    user

    O nome de usuário para conexão com o mecanismo de tabela larga do Lindorm.

    password

    test

    A senha para conexão com o mecanismo de tabela larga do Lindorm.

    Importante
    • Caso tenha esquecido a senha, você pode redefinir a senha do usuário no sistema de gerenciamento de cluster do mecanismo de tabela larga do Lindorm.

    • Após redefinir a senha, reinicie o mecanismo no console.

    Exemplo de conexão

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

    Uma conexão bem-sucedida retorna o seguinte resultado:

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

    Neste caso, 2.0.xx representa o número da versão do Lindorm-cli.

Método 2

Clique duas vezes para abrir o programa Lindorm-cli.exe e execute o seguinte comando:

connect <jdbc url> <username> <password>

Exemplo de conexão

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

Uma conexão bem-sucedida não gera saída no terminal.

Conectar ao mecanismo de tabela larga usando o protocolo nativo do HBase

Importante

Somente versões do lindorm-cli 2.4.0 e posteriores suportam conexão com o mecanismo de tabela larga via protocolo HBase.

Quando usar o modo HBase

Na maioria dos cenários, recomendamos o uso do protocolo MySQL (ou Avatica) para acessar o mecanismo de tabela larga via SQL: o SQL oferece suporte completo às capacidades da tabela larga (índices secundários, consultas multicolumna, agregação, paginação, entre outros), além de um ecossistema e conjunto de ferramentas mais ricos.

O modo HBase é recomendado apenas nas situações abaixo:

  • Dados migrados do HBase open-source: Suas tabelas e dados estavam originalmente armazenados no HBase open-source e foram migrados para o mecanismo de tabela larga do Lindorm usando ferramentas como o LTS.

  • Hábitos ou scripts existentes do HBase: Você já conhece a sintaxe de comandos do HBase Shell (create, put, get, scan, describe, etc.) e deseja utilizá-los diretamente sem precisar reescrevê-los em SQL.

  • Gerenciamento de tabelas no estilo HBase: É necessário realizar operações como definir atributos de família de colunas ou gerenciar namespaces.

Método de conexão

O modo HBase utiliza o formato de URL dedicado hbase://<host>:<port>:

./lindorm-cli -url "hbase://<host>:30020" -username <username>

O prefixo hbase:// é obrigatório. Diferentemente do protocolo MySQL, onde o prefixo mysql:// é opcional, omitir o prefixo hbase:// faz com que a conexão seja interpretada como protocolo MySQL em vez de modo HBase.

A senha é opcional no modo HBase. Se a autenticação for necessária, passe-a através do parâmetro -password ou da variável de ambiente LINDORM_PASSWORD.

Após uma conexão bem-sucedida, você pode inserir comandos do HBase Shell diretamente na interface interativa. Os comandos do HBase não terminam com ponto e vírgula (;). Pressione Enter para executar cada comando.

Uso

O Lindorm-cli suporta modos interativo e não interativo para execução de instruções SQL no mecanismo de tabela larga.

Executar instruções SQL no modo interativo

Geralmente, inicia-se o lindorm-cli no modo interativo para operar o mecanismo de tabela larga. O fluxo de trabalho é o seguinte:

  1. Iniciar o lindorm-cliApós conectar-se ao mecanismo de tabela larga do Lindorm usando qualquer protocolo descrito na seção anterior, seu terminal entra na interface interativa do lindorm-cli e aguarda novos comandos.

    Nota

    No Windows, clicar duas vezes no lindorm-cli.exe abre uma janela de terminal CMD. Isso inicia a interface interativa do lindorm-cli, mas não estabelece conexão com o mecanismo de tabela larga do Lindorm. É necessário usar o subcomando connect para estabelecer a conexão antes de executar instruções SQL. Para mais informações, consulte Cliente implantado em Windows e Método 2.

  2. Inserir instruções SQL para acessar o mecanismo de tabela largaApós estabelecer a conexão e entrar na interface interativa, insira instruções SQL para acessar o mecanismo de tabela larga. Para sintaxe SQL suportada, consulte Referência SQL.

  3. Sair do lindorm-cliApós concluir suas operações na interface interativa, saia do lindorm-cli executando o subcomando exit ou pressionando o atalho de teclado ctrl+d.

Nota

Ao iniciar o lindorm-cli no modo interativo e conectar-se com sucesso ao mecanismo de tabela larga, o cliente mantém uma sessão com o mecanismo até que você saia. Todas as operações SQL durante esse período são executadas na mesma sessão. Observe que, se a sessão permanecer ociosa por muito tempo, o sistema desconecta automaticamente para liberar recursos.

Executar instruções SQL no modo não interativo

Ao escrever scripts de O&M, para executar diretamente instruções SQL do Lindorm sem entrar na linha de comando interativa, utilize o modo não interativo do lindorm-cli para trabalhar com o LindormTable. Esse modo executa SQL diretamente via parâmetros de comando e retorna os resultados, sendo adequado para tarefas automatizadas, como consultas ou operações estatísticas.

Para executar uma instrução SQL no modo não interativo a partir de um terminal shell, anexe o parâmetro -execute seguido pela instrução SQL entre aspas simples ou duplas aos parâmetros de conexão (como endereço do host e porta) descritos em Métodos de conexão. Isso estabelece rapidamente uma conexão de curta duração e executa o comando. Exemplo:

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

Também é possível exportar resultados de consultas da tabela larga para um arquivo CSV usando o modo não interativo.

Importante

A exportação para CSV requer a versão 2.2.0 ou posterior do lindorm-cli. Para verificar sua versão atual:

  • Execute lindorm-cli -version na linha de comando.

  • Verifique a versão exibida na mensagem de boas-vindas ao entrar no modo interativo.

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;"
Nota
  • Conexões de curta duração: No modo não interativo, o lindorm-cli estabelece uma nova conexão para cada instrução SQL e a fecha imediatamente após a execução.

  • Controle de saída: Os resultados são impressos na tela do terminal (stdout) por padrão. Para redirecionar a saída para um arquivo, use o parâmetro -output.

Usar o lindorm-cli com AI Agent

Além dos modos interativo e não interativo, o lindorm-cli também pode ser invocado por AI Agents. Quando você deseja usar linguagem natural para permitir que um AI Agent realize automaticamente consultas de dados no Lindorm, análise de resultados ou geração de scripts de O&M, combine o Lindorm Agent Skill com o lindorm-cli.

Nota

As capacidades orientadas a AI Agent descritas abaixo exigem a versão 2.3.0 ou posterior do lindorm-cli.

Cenários

O uso do lindorm-cli através de um AI Agent é adequado para os seguintes cenários:

  • Consultas de dados em linguagem natural: Descreva sua intenção de consulta em linguagem natural. O Agent gera e executa instruções SQL e retorna resultados estruturados.

  • Geração de scripts de O&M em lote: Permita que o Agent gere scripts que chamam o lindorm-cli com base nos seus requisitos para tarefas agendadas ou processamento de dados em lote.

  • Exportação estruturada de resultados: Use o Agent para exportar resultados de consultas diretamente em formatos analisáveis por máquina, como JSON ou JSONL, para processamento posterior.

Instalar o Lindorm Agent Skill

O Lindorm Agent Skill fornece aos AI Agents o contexto necessário para chamar o lindorm-cli. Ele orienta o Agent a detectar automaticamente a instalação local do lindorm-cli, selecionar parâmetros apropriados e construir comandos.

Você pode baixar o Lindorm Agent Skill em: alibabacloud-lindorm-agent-skill

Após a instalação, o Agent pode chamar o lindorm-cli para acessar o mecanismo de tabela larga do Lindorm diretamente nas conversas. O Skill consolida as capacidades e parâmetros da CLI descritos abaixo, de modo que geralmente não é necessário inserir esses parâmetros manualmente.

Uso do Agent

Após instalar o Lindorm Agent Skill, basta descrever seus requisitos em linguagem natural. O Agent realiza automaticamente detecção, consultas, controles de segurança e injeção de credenciais sob a orientação do Skill.

Detecção automática de capacidades do lindorm-cli pelo Agent

Antes da primeira chamada, o Agent detecta a versão do lindorm-cli, protocolos suportados, formatos de saída e definições de códigos de saída no ambiente atual. Isso permite que o Agent escolha o método de invocação correto com base no ambiente real, em vez de depender de suposições codificadas.

Nota

Esse comportamento está integrado ao Lindorm Agent Skill e corresponde ao parâmetro --capabilities do lindorm-cli.

Retorno de resultados em formato estruturado pelo Agent

Quando o Agent executa uma consulta, ele exige que o lindorm-cli produza resultados em formato JSON ou JSONL. Apenas os dados resultantes da consulta são enviados para stdout; mensagens de status e avisos vão para stderr. Os dois fluxos são isolados para facilitar a análise pelo Agent.

Para grandes conjuntos de resultados, o Agent usa o formato JSONL para consumir os resultados linha por linha, evitando carregar todos os dados de uma vez.

Nota

Esse comportamento está integrado ao Lindorm Agent Skill e corresponde aos parâmetros -format json e -format jsonl do lindorm-cli.

Ativação de barreiras de segurança pelo Agent

O Lindorm Agent Skill ativa o modo seguro por padrão, interceptando operações de escrita de alto risco, como DROP TABLE, TRUNCATE TABLE e DELETE FROM, no lado do cliente para evitar que o Agent execute acidentalmente SQL destrutivo. O Skill também limita o número máximo de linhas retornadas por consulta para impedir que grandes conjuntos de resultados esgotem a janela de contexto do Agent.

Nota

Esse comportamento está integrado ao Lindorm Agent Skill e corresponde aos parâmetros --safe-mode e --max-rows do lindorm-cli.

Injeção segura de credenciais pelo Agent

Quando o Agent chama o lindorm-cli, o Skill prioriza a injeção de nomes de usuário e senhas através de variáveis de ambiente ou entrada padrão, evitando que as credenciais apareçam em argumentos de linha de comando, histórico do Shell ou listagens de processos.

Nota

Esse comportamento está integrado ao Lindorm Agent Skill e corresponde à injeção de credenciais via variável de ambiente e ao parâmetro --password-stdin do lindorm-cli.

Parâmetros de linha de comando e subcomandos

Parâmetros de linha de comando

Ao iniciar o lindorm-cli em um terminal, você pode especificar os seguintes parâmetros de linha de comando:

Nome do parâmetro

Requer valor

Valor

Descrição

url

Sim

Nome do protocolo + string de conexão SQL (incluindo porta) para o mecanismo de tabela larga do Lindorm

Especifica o protocolo e a string de conexão para o lindorm-cli se conectar ao mecanismo de tabela larga.

username

Sim

Nome de usuário para a conexão

O nome de usuário especificado deve ser um usuário Lindorm já criado no mecanismo de tabela larga.

password

Sim

Senha para o nome de usuário

-

database

Sim

Nome do banco de dados para conexão

Se não especificado, o banco de dados padrão é usado. Se especificado, o banco de dados já deve existir no mecanismo de tabela larga.

execute

Sim

Instrução SQL a ser executada

Quando o parâmetro execute é especificado, o lindorm-cli roda no modo não interativo. Coloque a instrução SQL entre aspas simples ou duplas.

Nota

Ao usar aspas duplas para envolver a instrução SQL, escape aspas duplas internas com uma barra invertida \. Aspas simples não suportam escape.

output

Sim

Local de saída para resultados da execução SQL no modo não interativo

No modo não interativo, se output não for especificado, os resultados são impressos na saída padrão. Se especificado, os resultados são gravados no arquivo no caminho indicado. Se o arquivo não existir, ele será criado.

format

Sim

Um dos seguintes:

horizontal, vertical, csv, json, column

Altera o formato dos resultados de execução SQL retornados pelo mecanismo de tabela larga. O formato padrão é column.

  • column: Exibe resultados em formato de tabela comum.

  • horizontal: Exibe dados horizontalmente por coluna.

  • vertical: Exibe dados verticalmente por linha, semelhante ao formato \G na linha de comando do MySQL.

  • csv: Exibe resultados em formato CSV sem bordas de tabela.

  • json: Exibe resultados em formato JSON.

pretty

Não

-

Use com format definido como JSON.

Quando ativado, os resultados são produzidos como JSON formatado (pretty-printed). Por padrão, os resultados são produzidos como JSON compacto.

csvNoHeader

Não

-

Use com format definido como CSV.

Quando ativado, os resultados são produzidos em formato CSV sem cabeçalhos de coluna.

nullString

Sim

String para substituir valores NULL

Use com format definido como CSV.

Quando especificado, valores NULL nos resultados da consulta são substituídos pela string fornecida.

Se nullString não for especificado, valores NULL são produzidos da seguinte forma:

  • Quando conectado via protocolo MySQL, valores NULL são representados como \N.

  • Quando conectado via protocolo Avatica, valores NULL são representados como strings vazias.

version

Não

-

Exibe as informações de versão do lindorm-cli. O Lindorm-cli não inicia nem entra no modo interativo quando este parâmetro é usado.

format

Sim

Um dos seguintes: horizontal, vertical, csv, json, jsonl, column

Altera o formato dos resultados de execução SQL retornados pelo mecanismo de tabela larga. O padrão é column.

  • column: Exibe resultados em formato de tabela padrão.

  • horizontal: Exibe dados horizontalmente por coluna.

  • vertical: Exibe dados verticalmente por linha.

  • csv: Exibe resultados em formato CSV sem bordas de tabela.

  • json: Exibe resultados em formato JSON para análise pelo Agent.

  • jsonl: Um objeto JSON independente por linha, adequado para Agents consumirem grandes conjuntos de resultados de maneira streaming.

capabilities

Não

-

Produz uma declaração JSON das capacidades do lindorm-cli, incluindo mecanismos suportados, formatos, códigos de saída e parâmetros. Em cenários de AI Agent, isso é chamado automaticamente pelo Lindorm Agent Skill.

safe-mode

Não

-

Quando ativado, o cliente intercepta operações de escrita de alto risco, como DROP TABLE, TRUNCATE TABLE e DELETE FROM. Em cenários de AI Agent, isso é ativado por padrão pelo Lindorm Agent Skill.

max-rows

Sim

Inteiro positivo

Limita o número máximo de linhas retornadas pelo cliente. Linhas excedentes são truncadas. Em cenários de AI Agent, isso é definido por padrão pelo Lindorm Agent Skill para evitar que grandes conjuntos de resultados esgotem a janela de contexto do Agent.

password-stdin

Não

-

Lê a senha da entrada padrão para evitar que ela apareça em argumentos de linha de comando. Em cenários de AI Agent, o Lindorm Agent Skill prioriza isso em vez do parâmetro simples -password.

Nota

Todos os parâmetros de linha de comando do lindorm-cli devem ter o prefixo hífen -.

Subcomandos comuns

Após iniciar o lindorm-cli no modo interativo, você pode executar subcomandos do lindorm-cli na interface interativa para controlar seu comportamento, além de enviar instruções SQL para o mecanismo de tabela larga do Lindorm. Os subcomandos comuns estão listados abaixo:

Subcomando

Parâmetros

Descrição

connect

<url> <username> <password>

Quando o lindorm-cli é iniciado no modo interativo sem uma conexão, use o subcomando connect para estabelecer uma conexão com o mecanismo de tabela larga do Lindorm.

Os parâmetros url, username e password têm os mesmos significados que os parâmetros de linha de comando url, username e password.

format

Um dos seguintes:

horizontal, vertical, csv, json

O mesmo que o parâmetro format.

help

Nenhum

Exibe uma lista de subcomandos comuns.

history

Nenhum

Exibe instruções SQL ou subcomandos executados recentemente.

exit ou quit

Nenhum

Sai do lindorm-cli e desconecta do mecanismo de tabela larga do Lindorm.

FAQ

Por que estou enfrentando tempos limite ou falhas de conexão?

Tempos limite ou falhas de conexão retornam erros como Failed to connect to <wide table endpoint> connection check failed ou connection timeout.

Possíveis causas e soluções estão listadas abaixo. Verifique-as em ordem:

Causa

Solução

Uso de conexão de rede pública sem adicionar o endereço IP público à lista de permissões.

Adicionar o endereço IP público do cliente à lista de permissões do Lindorm.

Para encontrar o endereço IP público do seu cliente, execute curl ipinfo.io/ip ou curl ifconfig.me no Prompt de Comando do Windows (CMD).

O endereço IP público foi adicionado à lista de permissões, mas os tempos limite de conexão persistem.

A instabilidade da rede pode ser a causa. Recomendamos mudar para uma conexão VPC.

Acesso a partir de uma instância ECS sem adicionar o endereço IP do ECS à lista de permissões do Lindorm.

Obter o endereço IP do ECS e adicioná-lo à lista de permissões do Lindorm.

Uso de um endpoint incorreto.

Os endpoints do Lindorm diferem para conexões via VPC e rede pública. Use o endpoint correto com base no seu ambiente de rede.

Se nenhuma dessas soluções resolver seu problema, entre em contato com o suporte técnico do Lindorm (ID do DingTalk: s0s3eg3).

Referências