Generating SQL for Postgres using OpenAI via Vanna.AI (Recommended), Vanna Hosted Vector DB (Recommended)¶

This notebook runs through the process of using the vanna Python package to generate SQL using AI (RAG + LLMs) including connecting to a database and training. If you're not ready to train on your own database, you can still try it using a sample SQLite database.

Which LLM do you want to use?

[Selected] OpenAI via Vanna.AI (Recommended)
Use Vanna.AI for free to generate your queries
OpenAI
Use OpenAI with your own API key
Azure OpenAI
If you have OpenAI models deployed on Azure
Mistral via Mistral API
If you have a Mistral API key
Other LLM
If you have a different LLM model

Where do you want to store the 'training' data?

[Selected] Vanna Hosted Vector DB (Recommended)
Use Vanna.AIs hosted vector database (pgvector) for free. This is usable across machines with no additional setup.
ChromaDB
Use ChromaDBs open-source vector database for free locally. No additional setup is necessary -- all database files will be created and stored locally.
Marqo
Use Marqo locally for free. Requires additional setup. Or use their hosted option.
Other VectorDB
Use any other vector database. Requires additional setup.

Setup¶

In [ ]:

%pip install 'vanna[postgres]'

In [ ]:

import vanna
from vanna.remote import VannaDefault

In [ ]:

api_key = vanna.get_api_key('my-email@example.com')

vanna_model_name = # Put a unique name here
vn = VannaDefault(model=vanna_model_name, api_key=api_key)

Which database do you want to query?

[Selected] Postgres
Snowflake
BigQuery
SQLite
Other Database
Use Vanna to generate queries for any SQL database

In [ ]:

vn.connect_to_postgres(host='my-host', dbname='my-dbname', user='my-user', password='my-password', port='my-port')

Training¶

You only need to train once. Do not train again unless you want to add more training data.

In [ ]:

# The information schema query may need some tweaking depending on your database. This is a good starting point.
df_information_schema = vn.run_sql("SELECT * FROM INFORMATION_SCHEMA.COLUMNS")

# This will break up the information schema into bite-sized chunks that can be referenced by the LLM
plan = vn.get_training_plan_generic(df_information_schema)
plan

# If you like the plan, then uncomment this and run it to train
# vn.train(plan=plan)

In [ ]:

# The following are methods for adding training data. Make sure you modify the examples to match your database.

# DDL statements are powerful because they specify table names, colume names, types, and potentially relationships
vn.train(ddl="""
    CREATE TABLE IF NOT EXISTS my-table (
        id INT PRIMARY KEY,
        name VARCHAR(100),
        age INT
    )
""")

# Sometimes you may want to add documentation about your business terminology or definitions.
vn.train(documentation="Our business defines OTIF score as the percentage of orders that are delivered on time and in full")

# You can also add SQL queries to your training data. This is useful if you have some queries already laying around. You can just copy and paste those from your editor to begin generating new SQL.
vn.train(sql="SELECT * FROM my-table WHERE name = 'John Doe'")

In [ ]:

# At any time you can inspect what training data the package is able to reference
training_data = vn.get_training_data()
training_data

In [ ]:

# You can remove training data if there's obsolete/incorrect information. 
vn.remove_training_data(id='1-ddl')

Asking the AI¶

Whenever you ask a new question, it will find the 10 most relevant pieces of training data and use it as part of the LLM prompt to generate the SQL.

In [ ]:

vn.ask(question=...)

Launch the User Interface¶

vanna-flask

In [ ]:

from vanna.flask import VannaFlaskApp
app = VannaFlaskApp(vn)
app.run()

Next Steps¶

Using Vanna via Jupyter notebooks is great for getting started but check out additional customizable interfaces like the