DbRheo-CLI: ferramenta de linha de comando para manipulação de bancos de dados e análise de dados usando linguagem natural

O DbRheo-CLI é uma ferramenta de agente de linha de comando para operações de banco de dados e análise de dados. Ela permite que os usuários forneçam comandos em linguagem natural, que a ferramenta converte em consultas SQL seguras e executa. A ferramenta também explora e analisa automaticamente a estrutura do banco de dados e possui um sistema integrado de avaliação de riscos para pré-detectar e alertar sobre operações perigosas. Além da manipulação direta do banco de dados, o DbRheo-CLI tem um ambiente Python integrado que suporta a gravação e a execução de código Python diretamente da linha de comando para análise de dados, visualização de dados e criação de scripts automatizados. Os resultados das consultas e análises podem ser facilmente exportados para vários formatos, como CSV, JSON e Excel. Atualmente, ele oferece suporte a vários bancos de dados convencionais, como PostgreSQL, MySQL e SQLite.

Lista de funções

• consulta em linguagem naturalOperar bancos de dados diretamente na linguagem do discurso cotidiano.
• Geração inteligente de SQL: converte automaticamente os comandos de linguagem natural do usuário em instruções de consulta SQL otimizadas e seguras.
• Explorando a arquitetura do banco de dadosAnálise da estrutura da tabela: Você pode analisar e exibir dinamicamente informações sobre a estrutura da tabela de um banco de dados.
• Sistemas de avaliação de riscos: o sistema realiza pré-testes e alerta os usuários antes de realizar operações arriscadas no banco de dados (por exemplo, excluir dados).
• Execução de código PythonSuporte para execução de código Python dentro da ferramenta para análise de dados, criação de gráficos ou execução de tarefas automatizadas.
• Exportação de dadosSuporte para salvar os resultados da consulta como arquivos CSV, JSON e Excel.
• Suporte a vários bancos de dadosCompatível com PostgreSQL, MySQL, SQLite e muitos outros bancos de dados.
• processamento assíncronoExecução assíncrona de tarefas para melhorar o desempenho do tempo de execução.
• saída de streamingExibição em tempo real do processo e dos resultados da execução do comando.

Usando a Ajuda

A seguir, há uma descrição detalhada de como instalar e usar o DbRheo-CLI, uma ferramenta de linha de comando.

Requisitos ambientais

Antes de iniciar a instalação, verifique se o computador atende às seguintes condições:

• PythonVersão 3.9 ou superior é necessária.
• Chave da APIÉ necessário ter uma chave de API do Google ou da OpenAI para conduzir as funções de processamento de linguagem natural.

Etapas de instalação

1. Repositório de código clone
   Primeiro, abra o terminal (interface de linha de comando) de seu computador e use o comandogitclona o código do projeto localmente a partir do GitHub.

   git clone https://github.com/Din829/DbRheo-CLI.git
   

   Em seguida, vá para o diretório do projeto.

   cd DbRheo-CLI
   

2. Instalação de bibliotecas dependentes
   Há uma série de bibliotecas Python de terceiros necessárias para executar o projeto, que estão documentadas na seçãorequirements.txtarquivo. Use opippara instalá-los.

   pip install -r requirements.txt
   

3. Configuração de variáveis de ambiente
   O projeto contém um arquivo chamado.env.exampledo arquivo de variável de ambiente de exemplo. Você precisa copiar esse arquivo e renomeá-lo.enve, em seguida, preencha suas próprias informações de configuração.

   cp .env.example .env
   

   Em seguida, use um editor de texto para abrir o arquivo.envlocalize e defina o seguinte:

   • GOOGLE_API_KEY talvez OPENAI_API_KEYPreencha pelo menos um desses dois campos com sua chave de API.
   • Informações de conexão com o banco de dadosDependendo do tipo de banco de dados ao qual você deseja se conectar (por exemplo, PostgreSQL, MySQL ou SQLite), preencha as informações de host, porta, nome de usuário, senha e nome do banco de dados.
4. Iniciando a ferramenta de linha de comando
   Depois que todas as configurações forem concluídas, vá para a seçãopackages/clidiretório, executecli.pypara iniciar o programa.

   cd packages/cli
   python cli.py
   

   Após um lançamento bem-sucedido, você veráDbRheo>indicando que agora você pode começar a digitar comandos.

Como usar

O principal modo de operação da DbRheo-CLI é inserir instruções em linguagem natural ou comandos específicos em sua linha de comando interativa.

• Exibir ajuda:
  Se não tiver certeza de quais comandos estão disponíveis, você pode digitar/helppara obter informações de ajuda.
• Escolha de um modelo de idioma:
  Se você tiver várias chaves de API configuradas ao mesmo tempo, poderá usar a opção/modelpara selecionar o modelo do idioma principal a ser usado no diálogo atual.

Exemplos de uso básico

1. Estrutura da tabela de pesquisa
   Você pode usar a linguagem natural para perguntar sobre a estrutura de uma tabela em um banco de dados.

   DbRheo> 告诉我users表的结构是什么
   ```    工具会返回该表的字段、数据类型等详细信息。
   

2. Consultar dados
   Você pode usar a linguagem natural para fazer a ferramenta consultar os dados, por exemplo, para os 10 usuários mais recentes.

   DbRheo> 帮我查询最新的10个用户
   

   A ferramenta gerará automaticamente a instrução SQL correspondente SELECT * FROM users ORDER BY created_at DESC LIMIT 10; e executá-lo e, em seguida, mostrar os resultados.

Exemplo de análise de dados

Você pode chamar o Python diretamente da linha de comando para análise e visualização de dados.

Suponha que você queira analisar os dados de vendas e gerar um gráfico, você pode inseri-lo da seguinte forma:

DbRheo> 使用Python分析并可视化销售数据

gera e executa um trecho de código Python que usa opandasA biblioteca lê os dados de vendas do banco de dados e, em seguida, usa a funçãomatplotlibA biblioteca gera um gráfico de barras mostrando as tendências de vendas mensais e salva o gráfico como um arquivo de imagemsales_analysis.png.

Consultas SQL avançadas

Para requisitos de consulta complexos, você também pode descrevê-los diretamente em linguagem natural.

Por exemplo, você precisa contar a quantidade total de pedidos mensalmente:

DbRheo> 创建一个销售数据的月度汇总

A ferramenta gera uma instrução SQL semelhante à seguinte para concluir a consulta agregada.

SELECT
DATE_TRUNC('month', order_date) as month,
SUM(amount) as total_sales
FROM orders
GROUP BY month
ORDER BY month;

cenário do aplicativo

1. Consulta rápida de dados
   Para os membros da equipe que não estão familiarizados com SQL (por exemplo, gerentes de produto, equipe de operações), eles podem usar a linguagem natural para obter os dados de que precisam diretamente do banco de dados, por exemplo, "consultar o número de usuários que se registraram na última semana", sem precisar esperar pelo suporte do desenvolvedor.
2. Análise de dados e relatórios
   Os analistas de dados podem analisar dados de bancos de dados em tempo real, gerar estatísticas e gráficos visuais e exportar os resultados para arquivos Excel ou CSV para produção de relatórios, usando comandos de linguagem natural combinados com scripts Python, diretamente da ferramenta de linha de comando.
3. Explorando a arquitetura do banco de dados
   Os desenvolvedores que se aproximam de um novo banco de dados podem entender rapidamente o design e as relações entre as tabelas por meio de comandos de linguagem natural, como "diga-me a estrutura de uma tabela" ou "liste todas as tabelas", sem a necessidade de ferramentas pesadas de gerenciamento de banco de dados.
4. Operação segura do banco de dados
   Quando os administradores de banco de dados realizam algumas operações de alto risco (como atualização ou exclusão de dados), eles podem usar a função de avaliação de risco da ferramenta para entender o possível impacto da operação com antecedência e evitar a perda de dados devido ao uso indevido.

QA

1. Que tipos de bancos de dados são compatíveis com essa ferramenta?
   Atualmente, ele oferece suporte principalmente aos bancos de dados PostgreSQL, MySQL/MariaDB e SQLite. Ao mesmo tempo, ele usa uma arquitetura de plug-in que pode ser estendida para oferecer suporte a outros tipos de bancos de dados por meio da criação de novos adaptadores.
2. Tenho que pagar para usar essa ferramenta?
   A ferramenta em si é de código aberto e de uso gratuito. No entanto, ela precisa chamar grandes APIs de modelagem de linguagem fornecidas por empresas como Google ou OpenAI, e esses provedores de serviços de API cobrarão com base no uso que você fizer dela.
3. As informações de conexão do meu banco de dados e as chaves de API estão seguras?
   Suas informações de conexão com o banco de dados e a chave de API são armazenadas localmente no arquivo.envele não é carregado em nenhum servidor e, portanto, é seguro. Você precisa se certificar de manter seu ambiente local seguro.
4. E se a instrução SQL gerada pela ferramenta não atender às minhas expectativas?
   A ferramenta exibe a instrução gerada antes de executar o SQL. Você pode verificar se a instrução está correta. Se o resultado não for o esperado, você pode tentar uma instrução de linguagem natural diferente, mais clara e mais específica para orientar a ferramenta a gerar o SQL correto.