Skip to content
Nappai Documentation

SQL Query Constructor

This component lets you ask questions about your database in plain language, and it will automatically translate your request into a SQL query that Nappai can understand and execute. It’s designed to be safe, so you won’t accidentally modify your data.

Relationship with Language Models (LLMs)

This component uses a powerful language model (LLM) to understand your requests and generate the correct SQL query. The LLM helps translate your natural language questions into the precise language needed for database interaction.

Inputs

  • Database: Select the database you want to query from.
  • Top K: Specify the maximum number of results you want to see. This number must be greater than 0. For example, if you want to see the top 5 results, enter 5.
  • Input request: Type your question or request about the data in the database. For example: “Show me the names of all customers in California.”
  • LLM: This setting selects the language model Nappai will use to process your request. This is usually pre-configured and you may not need to change it.

Outputs

  • Text: This output shows the generated SQL query. You can copy this query if needed, but you don’t usually need to interact with this directly. Nappai will automatically execute the query and display the results in the dashboard.

Usage Example

Let’s say you want to find the top 3 most expensive products in your database.

  1. Database: Select your “Products” database.
  2. Top K: Enter 3.
  3. Input request: Type “Show me the 3 most expensive products.”
  4. The component will generate a SQL query and Nappai will display the results in the dashboard.

Templates

This component is used in various Nappai dashboards and workflows, but its configuration is usually handled automatically.

(This section will be populated with links to other relevant components once they are defined.)

Tips and Best Practices

  • Be as clear and specific as possible in your input request. The more precise your question, the better the results.
  • If you’re unsure about the structure of your database, consult your database documentation or contact your administrator.
  • Experiment with different phrasing of your requests to see how the generated SQL query changes.

Security Considerations

This component is designed to be read-only. It will only generate SQL queries that select data; it cannot modify or delete data. Nappai’s security measures further protect your database from unauthorized access.