Skip to content
Nappai Documentation

SQL Executor

This component lets you run SQL queries (database commands) directly within Nappai to get information from your database. It’s like having a built-in database assistant. You provide the query and database connection details, and it returns the results.

Relationship with SQL Databases

This component connects to your SQL database (like MySQL, PostgreSQL, etc.) using the database URL you provide. It sends your SQL query to the database, receives the results, and presents them in a user-friendly format within Nappai.

Inputs

  • Database URL: The address of your database. This is essential; Nappai needs this to know where to find your data. It’s usually a string that looks something like mysql://user:password@host:port/database. Your database administrator can provide this.
  • Include Columns: A simple yes/no switch. If “yes,” the names of the columns in your database results will be included in the output. If “no,” only the data values will be shown.
  • Passthrough: A yes/no switch. If an error occurs, and this is set to “yes,” Nappai will show you the SQL query you tried to run instead of an error message. This helps in debugging.
  • Add Error: A yes/no switch. If an error occurs, and this is set to “yes,” the error message will be included in the output along with the query (if Passthrough is also enabled).
  • Query to run: The actual SQL query you want to execute. This is the command that tells your database what information to retrieve. For example: SELECT * FROM customers WHERE city = 'London';

Outputs

The component produces a single output: Text. This output contains the results of your SQL query. If there’s an error and “Passthrough” is enabled, it will show the query instead. If “Add Error” is enabled, any error messages will be included in the output. You can then use this text output in other parts of your Nappai workflow, such as displaying the results on a chart or using them as input for another component.

Usage Example

Let’s say you want to find all customers from London.

  1. In the Database URL input, enter your database connection string (e.g., mysql://user:password@host:port/database).
  2. In the Query to run input, enter your SQL query: SELECT * FROM customers WHERE city = 'London';
  3. Leave Include Columns as “yes” to see column names in the results.
  4. Leave Passthrough and Add Error as “no” for standard error handling.
  5. Run the component.

The Text output will contain the list of customers from London.

Templates

This component is used in the ‘Ask your Database’ template.

  • Explain SQL results: This component helps you understand the results of your SQL query in plain language. Use this after the SQL Executor to get a human-readable summary of your data.
  • SQL Query Constructor: This component helps you build your SQL queries easily, even if you’re not familiar with SQL syntax.

Tips and Best Practices

  • Always test your SQL queries separately before using them in Nappai to avoid errors.
  • Use clear and concise SQL queries for better performance and readability.
  • If you encounter errors, check the “Passthrough” and “Add Error” settings to get more information for debugging.
  • Consult your database documentation for specific SQL syntax and functions.

Security Considerations

  • Never hardcode sensitive information like database passwords directly into your SQL queries or the Database URL input. Use environment variables or secure configuration methods to manage sensitive data.
  • Ensure your database server is properly secured and only accessible to authorized users.
  • Regularly review and update your database security settings.