vinta
Update README.md
TESH-Query - AI-powered CLI tool that converts natural language queries into SQL, retrieves data from databases, and allows CSV downloads.
- Error Reduction: Minimizes human errors associated with manual SQL writing.
- Democratized Data Access: Allows non-technical users to interact with databases effortlessly.
What is this Python project?
TESHQ is an AI-powered CLI tool designed to convert natural language queries into SQL. It retrieves data directly from your databases and allows for easy CSV exports. This tool significantly enhances productivity by enabling developers, analysts, and even users with limited SQL knowledge to interact with databases seamlessly. TESH-Query is under active development, and we warmly welcome contributions from the community!
What's the difference between this Python project and similar ones?
TESHQ distinguishes itself through a powerful combination of features tailored for efficiency and ease of use:
- Natural Language to SQL: Simply ask your questions in plain English; no need to write complex SQL queries.
- AI-Powered Translation: Leverages Google's Gemini AI (via Langchain) for intelligent and accurate SQL generation.
- Broad Database Compatibility: Works seamlessly with popular databases including PostgreSQL, MySQL, and SQLite.
- Schema-Aware Queries: Intelligently understands your database's structure to provide relevant and precise responses.
- Versatile Formatted Output: Displays query results in a clean, readable table directly in your terminal. It also supports JSON and CSV export for further analysis and reporting.
- Secure Configuration: Includes robust support for credential management and secure database setup.
- Modern CLI Experience: Built with Typer and Rich to offer a visually appealing, intuitive, and responsive command-line interface.
- Enhanced Productivity: Empowers users to retrieve data swiftly without manual SQL coding, significantly reducing query time and effort.
- Error Minimization: By automating SQL generation from natural language, TESHQ drastically cuts down on syntax errors and logical flaws common in manual SQL writing.
The key differentiators are further highlighted in the comparison below:
| Feature | TESHQ | Traditional SQL Query Tools | Other AI SQL Tools |
|---|---|---|---|
| Natural Language Queries | ✅ Yes | ❌ No | ✅ Yes |
| AI-Powered SQL Generation | ✅ Yes (Gemini AI via Langchain) | ❌ No | ✅ Yes (varies by tool) |
| Database Compatibility | ✅ PostgreSQL, MySQL, SQLite | ✅ Varies | ✅ Varies |
| Schema Awareness | ✅ Yes | ❌ No | ✅ Yes |
| Formatted Output | ✅ Table, JSON, CSV | ❌ Limited | ✅ Varies |
| Security & Credential Mgmt | ✅ Yes | ✅ Yes | ✅ Yes |
| Modern CLI Interface | ✅ Typer & Rich | ❌ Basic CLI | ✅ Varies |
| Error Reduction | ✅ Yes | ❌ No | ✅ Yes |
| Boost Productivity | ✅ Yes | ❌ No | ✅ Yes |
In essence, TESHQ stands out due to its advanced AI-powered natural language processing, its highly intuitive and modern CLI experience (thanks to Typer and Rich), and its capability for flexible, structured data retrieval (Table, JSON, CSV), all while eliminating the complexities of manual SQL writing.
