Skip to content
Nappai Documentation

SQL Executor

This component lets you run SQL queries (database commands) to get information from your database. It’s easy to use and handles errors gracefully. You’ll use it to retrieve specific data needed for other parts of your automation workflows.

Relationship with SQL Databases

This component connects to your database using a URL you provide. It then sends your SQL query to the database and returns the results. It supports various database types (though the URL format might need slight adjustments, see below).

Inputs

  • Query: This is where you type the actual SQL query. This is the command that tells the database what information to retrieve. For example: SELECT * FROM customers WHERE country = 'USA';
  • Database URL: This is the address of your database. It usually looks something like this: postgres://user:password@host:port/database. Important: The component automatically adjusts PostgreSQL URLs, so you don’t need to worry about the exact format.
  • Include Columns: Check this box if you want the names of the columns (the headings of your data) included in the results. Otherwise, only the data itself will be returned. Defaults to unchecked (False).
  • Passthrough: If something goes wrong with your query, checking this box will return the original query instead of an error message. This is useful for debugging. Defaults to unchecked (False).
  • Add Error: If something goes wrong with your query, checking this box will return the original query and a detailed error message. This helps you understand what went wrong. Defaults to unchecked (False).

Outputs

The component produces text output. This output will be:

  • The data from your database if your query is successful.
  • Your original query (if “Passthrough” is checked) or a detailed error message (if “Add Error” is checked) if your query fails. This output can then be used by other Nappai components for further processing or error handling.

Usage Example

Let’s say you want to find all customers from the UK. You would:

  1. In the Query input, type: SELECT * FROM customers WHERE country = 'UK';
  2. In the Database URL input, paste the URL for your database.
  3. Leave the other inputs as their defaults (unchecked).
  4. Run the component.

The output will be a table of customer data from the UK.

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 easily interpret complex data.
  • SQL Query Constructor: This component helps you build your SQL query visually, making it easier to create complex queries without writing SQL code directly.

Tips and Best Practices

  • Test your queries separately: Before using them in Nappai, test your SQL queries in your database management tool to ensure they work correctly.
  • Use clear and concise queries: Avoid overly complex queries to improve readability and reduce errors.
  • Handle errors appropriately: Use the “Passthrough” and “Add Error” options to manage errors effectively in your workflow.

Security Considerations

  • Protect your database credentials: Never share your database URL (which includes your username and password) with anyone.
  • Use strong passwords: Choose strong and unique passwords for your database accounts.
  • Limit database access: Only grant necessary permissions to users and applications accessing your database. Review your database access regularly.