Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vikyw89/sql-agent
LLM agent able to do database queries and mutations
https://github.com/vikyw89/sql-agent
Last synced: about 1 month ago
JSON representation
LLM agent able to do database queries and mutations
- Host: GitHub
- URL: https://github.com/vikyw89/sql-agent
- Owner: vikyw89
- License: mit
- Created: 2024-06-13T16:46:45.000Z (6 months ago)
- Default Branch: alpha
- Last Pushed: 2024-06-16T12:47:30.000Z (6 months ago)
- Last Synced: 2024-10-12T08:45:29.747Z (2 months ago)
- Language: Jupyter Notebook
- Size: 25.8 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQL Agent Library
## Overview
The SQL Agent Library allows users to interact with SQL databases using natural human language. With this library, users can simply describe what data they want to retrieve or manipulate, and the library will convert these descriptions into precise SQL queries and execute them. This simplifies database interactions for those who may not be familiar with SQL syntax but need to access and manage data.
## Features
- **Natural Language Processing**: Convert human language queries into SQL statements.
- **Database Agnostic**: Works with various SQL databases (MySQL, PostgreSQL, SQLite, etc.).
- **Ease of Use**: Simple input-output mechanism to facilitate quick querying.
- **Flexibility**: Handles a variety of query types including SELECT, INSERT, UPDATE, and DELETE.
## Installation
To install the SQL Agent Library, use pip:
```bash
pip install sqlagent
```
## Usage
Here's a quick example to get you started:
### Step 1: Initiate instance
```python
# Create an instance of the SQLAgent
from sqlagent.agent import SQLAgent
agent = SQLAgent(db_connection_string="your_database_connection_string")
```
### Step 2: Query the Database
```python
await agent.arun("how many tables are there in my db ?")
```
## Configuration
You can configure the SQL Agent Library to connect to your specific database by providing the appropriate connection string during initialization.
it's utilizing sqlachemy under the hood
## Supported Databases
- MySQL
- PostgreSQL
- SQLite
## Contributing
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
We'd like to thank all contributors and supporters of this project. Your efforts help make database interactions simpler for everyone.
## Contact
For any questions or issues, please open an issue on GitHub or contact us at [email protected].