Skip to content
Nappai Documentation

SQL Query Database Tool

This tool lets you run database commands (called SQL queries) to retrieve information from your database. Think of it as a simple way to ask your database questions and get answers directly within Nappai. You don’t need to be a database expert to use it!

Relationship with SQL Databases

This component connects to your SQL database (like MySQL, PostgreSQL, etc.) to execute your queries. You’ll need to provide Nappai with the necessary information to connect to your database.

Inputs

  • SQLDatabase: This is where you specify which database you want to query. Nappai will need the details of your database connection (like the server address, username, and password) to make this work. This input is required; you must provide it for the tool to function.

Outputs

  • Tool: This output provides a ready-to-use tool that you can use to run your SQL queries. After setting up the database connection, this tool will be available to execute your queries and return the results. You’ll use this tool in other parts of your Nappai workflow to get data from your database.

Usage Example

Let’s say you want to find all customers from a specific city in your database. You would:

  1. Configure the SQLDatabase input: Provide the connection information for your database.
  2. Run the component: Nappai will create the “Tool” output.
  3. Use the “Tool” output in another Nappai component: You’ll then use this tool within another component (like an agent) to execute your SQL query (e.g., SELECT * FROM customers WHERE city = 'New York';).
  4. View the results: The results of your query will be available within the workflow, ready for use in other Nappai processes.

Templates

[This section will be populated with links to specific templates once they are available.]

  • OpenAI Function Agent: Uses OpenAI’s language models to generate text, potentially to help you formulate your SQL queries.
  • ReAct Agent LLM: An AI agent that can help you interact with the database tool more effectively.
  • XML Agent: Formats instructions as XML for the language model, potentially useful for complex database interactions.
  • OpenAI Tools Agent: Uses tools via the OpenAI tools API.
  • Tool Calling Agent: An agent designed to use tools like this SQL Query Database Tool.
  • SQLAgent: Specifically designed for interacting with SQL databases using an LLM and tools.
  • Sequential Task Agent, Sequential Task, CrewAI Agent, Hierarchical Task: These components are part of Nappai’s task management system and can be used to orchestrate the execution of your SQL queries within larger workflows.

Tips and Best Practices

  • Test your queries separately: Before using them in Nappai, test your SQL queries directly in your database management tool to ensure they work correctly.
  • Keep queries concise: Efficient queries will improve performance.
  • Use parameterized queries (if supported): This helps prevent SQL injection vulnerabilities.

Security Considerations

  • Secure your database credentials: Never hardcode database passwords directly into your Nappai workflows. Use secure methods for managing and accessing your database credentials.
  • Sanitize user inputs: If your SQL queries are based on user input, always sanitize the input to prevent SQL injection attacks. This is crucial for security.