TalkToSQL

TalkToSQL is an CLI tool that lets you query your DB with natural languages instead of SQL queries.

Usage

$ talktosql learn
Successfully saved the DB Schema Info to /Users/woniesong92/.talktosql_schema_info

$ talktosql ask --q "Find the total sales per author for books published after the year 1800"
SELECT a.name, SUM(b.price * o.quantity) as total_sales
FROM authors a
JOIN books b ON a.id = b.author_id
JOIN orders o ON b.id = o.book_id
WHERE b.publication_date > '1800-12-31'
GROUP BY a.name;
+--------------------+-------------+
|        name        | total_sales |
+--------------------+-------------+
|    J.K. Rowling    |    10.99    |
| George R.R. Martin |    12.99    |
|   J.R.R. Tolkien   |    23.98    |
|  Haruki Murakami   |    14.99    |
|    Jane Austen     |    29.97    |
+--------------------+-------------+

$ talktosql ask --q "1800년 이후로 출간된 책들의 매출을 작가별로 알려줘"
SELECT a.name, SUM(b.price * o.quantity) as total_sales
FROM authors a
JOIN books b ON a.id = b.author_id
JOIN orders o ON b.id = o.book_id
WHERE b.publication_date > '1800-12-31'
GROUP BY a.name;
+--------------------+-------------+
|        name        | total_sales |
+--------------------+-------------+
|    J.K. Rowling    |    10.99    |
| George R.R. Martin |    12.99    |
|   J.R.R. Tolkien   |    23.98    |
|  Haruki Murakami   |    14.99    |
|    Jane Austen     |    29.97    |
+--------------------+-------------+

Quickstart

Install the package
```
pip install talktosql -U
```

Set the environment variables

You can create a .env file in your local directory to get kickstarted.

OPENAI_API_KEY="SOME_API_KEY"
OPENAI_ORG_ID="SOME_ORG_ID"
OPENAI_MODEL_NAME="gpt-4"
TALKTOSQL_DATABASE_URL="mysql://myuser:mypassword@localhost/mydb"
TALKTOSQL_DATABASE_NAME="mydb"

Alternatively, you can run these in your terminal or set these in your terminal config (~/.zshrc)

export OPENAI_API_KEY="SOME_API_KEY"
export OPENAI_ORG_ID="SOME_ORG_ID"
export OPENAI_MODEL_NAME="gpt-4"
export TALKTOSQL_DATABASE_URL="mysql://myuser:mypassword@localhost/mydb"
# export TALKTOSQL_DATABASE_URL="postgresql://myuser:mypassword@localhost/mydb"
export TALKTOSQL_DATABASE_NAME="mydb"

Get the value for OPENAI_API_KEY from OpenAI API Keys
Get the value for OPENAI_ORG_ID from OpenAI Org Settings

Help TalktoSQL learn your DB Schema. This will save your DB schema info to a file in your home directory (~/.talktosql_schema_info)
```
talktosql learn
```

Query your DB in English instead of an SQL query

talktosql ask --q "Find the total sales per author for books published after the year 1800"

Try querying your DB in any natural language (e.g. Korean) instead of an SQL query

talktosql ask --q "1800년 이후로 출간된 책들의 매출을 작가별로 알려줘"

woniesong92/talktosql

TalkToSQL

Usage

Quickstart