talktosql 0.0.1

Query your DB using natural language instead of SQL queries

TalkToSQL

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

Usage

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

$ talktosql ask --q "Who owns a dog?"
SELECT o.first_name, o.last_name FROM Owners o JOIN Pets p ON o.owner_id = p.owner_id WHERE p.species = 'dog';
+------------+-----------+
| first_name | last_name |
+------------+-----------+
|    John    |    Doe    |
|    Jane    |    Doe    |
|    Bob     |   Smith   |
+------------+-----------+

$ talktosql ask --q "Is there anyone who owns a cat named Mittens?"
SELECT o.first_name, o.last_name FROM Owners o JOIN Pets p ON o.owner_id = p.owner_id WHERE p.species = 'cat' AND p.pet_name = 'Mittens';
+------------+-----------+
| first_name | last_name |
+------------+-----------+
|   Alice    |  Johnson  |
+------------+-----------+

Quickstart

1. Install the package

   pip install talktosql -U
   

2. 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

3. 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
   

4. Query your DB in English intead of an SQL query

   talktosql ask --q "how many dogs are there?"