The QueryWriter class is a utility for generating and executing SQL queries using natural language and OpenAI. It provides a simplified interface for interacting with your Val Town SQLite database and generating SQL queries based on user inputs.

This val is inspired by prisma-gpt. PRs welcome! See Todos below for some ideas I have.

1. Import the QueryWriter class into your script:

Create val
import { QueryWriter } from "https://esm.town/v/nbbaier/sqliteWriter";

2. Create an instance of QueryWriter, providing the desired table and an optional model:

Create val
const writer = new QueryWriter({ table: "my_table", model: "gpt-4-1106-preview" });

3. Call the writeQuery() method to generate an SQL query based on a user input string:

Create val
const userInput = "Show me all the customers with more than $1000 in purchases.";
const query = await writer.writeQuery(userInput);

4. Alternatively, use the gptQuery() method to both generate and execute the SQL query:

Create val
const userInput = "Show me all the customers with more than $1000 in purchases.";
const result = await writer.gptQuery(userInput);

5. Handle the generated query or query result according to your application's needs.

Creates a new instance of the QueryWriter class.

• table: The name of the database table to operate on.
• model (optional): The model to use for generating SQL queries. Defaults to "gpt-3.5-turbo".
• apiKey (optional): An OpenAI API key. Defaults to Deno.env.get("OPENAI_API_KEY").

Generates an SQL query based on the provided user input string.

• str: The user input string describing the desired query.

Returns a Promise that resolves to the generated SQL query.

Generates and executes an SQL query based on the provided user input string.

• str: The user input string describing the desired query.

Returns a Promise that resolves to the result of executing the generated SQL query.

• Handle multiple tables for more complex use cases
• Edit prompt to allow for more than just SELECT queries
• Allow a user to add to the system prompt maybe?
• Expand usage beyond just Turso SQLite to integrate with other databases

Migrated from folder: projects/gptTools/sqliteWriter