Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sathninduk authored Dec 2, 2024
1 parent 6773bd8 commit d668a68
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# ChatWithSQL

ChatWithSQL is a Python library to manage interaction between a Large Language Model (LLM) and an SQL database.
One of the major risks associated with Text-to-SQL systems is the potential for executing arbitrary SQL queries, which can lead to unauthorized data access or security breaches. Common mitigations include using restricted roles, read-only databases, and sandboxed environments. However, ChatWithSQL takes this one step further.

ChatWithSQL has implemented a schema-based validation approach to ensure that only SQL queries adhering to a predefined schema are generated and executed. This mechanism restricts the scope of data retrieval strictly within the defined parameters, effectively mitigating the risks of arbitrary or malicious queries. Each query is validated against the schema before execution, guaranteeing compliance and eliminating unauthorized access.

This unique approach positions ChatWithSQL as a leader in secure and reliable, natural language-driven SQL data retrieval.

## Installation

Expand Down Expand Up @@ -28,4 +32,4 @@ print(data)
```

## License
MIT License
MIT License

0 comments on commit d668a68

Please sign in to comment.