This add-on is operated by Hammerstone Development Corporation
Ask your database questions. Build and share beautiful dashboards.
Hello Query
Last updated April 25, 2024
The Hello Query add-on is currently in beta.
Table of Contents
Full Documentation
This documentation is a high-level summary of the add-on HelloQuery.
What is HelloQuery?
HelloQuery transforms natural language questions into database queries. It’s designed to understand your requests and translate them into SQL commands, fetching the data you need without writing a single line of SQL.
Here’s how it simplifies your workflow:
Natural Language Processing (NLP): At its core, Hello Query uses advanced NLP to understand your question and translate it into SQL. The AI is given an abbreviated schema and never sees your database data.
Query Translation: It then translates these questions into SQL queries using the schema and your question.
Data Retrieval and Reporting: The SQL queries are executed, and the results are returned in an easily digestible table format. Based on these results, you can create and export reports.
HelloQuery is particularly useful for businesses that need quick access to data insights without the bottleneck of technical query writing. It integrates seamlessly with Heroku Postgres, providing a versatile tool for data analysis.
Provisioning the add-on
HelloQuery can be attached to a Heroku application via the CLI:
A list of all plans available can be found here.
$ heroku addons:create helloquery
-----> Adding helloquery to sharp-mountain-4005... done, v18
After provisioning HelloQuery, type heroku addons:open helloquery from the Heroku CLI to open the add-on dashboard. You can also access the dashboard via the “Resources”, “Add-ons” section of your Heroku application page.
Connect your database
HelloQuery needs to connect to your database to be effective. There are two steps in this process: creating a read-only Postgres user and connecting to your database.
Create a read-only Postgres user
Visit your Heroku dashboard by visiting Heroku Dashboard and selecting the application you want to use. Select “Heroku Postgres” from the Add-ons menu. Next, click on “Credentials”-> “Create Credential.” Name the credential “HelloQueryAccess.” After creating the credential, attach it to your Heroku application and give it “Read-only” permissions.
Connect to HelloQuery
To access your HelloQuery dashboard, type heroku addons:open helloquery or click on HelloQuery in the “Resources” section from your Heroku application. When you open the dashboard, you will see a button that says “Heroku QuickConnect.” Click the button, and follow the steps to Oauth with Heroku. First, select the application you’d like to connect to. Second, select the read-only credential you just created called HELLOQUERYACCESS_URL.
That’s it! You’ll be redirected to the “Chat” tab of the dashboard, where you can start asking questions to your database immediately.
Migrating between plans
Use the heroku add-ons:upgrade command to migrate to a new plan.
$ heroku add-ons:upgrade helloquery:basic
-----> Upgrading helloquery:basic to sharp-mountain-4005... done, v18 ($49/mo)
Your plan has been updated to: helloquery:basic
Removing the add-on
You can remove HelloQuery via the CLI:
This will destroy all queries and scheduled reports and cannot be undone!
$ heroku add-ons:destroy helloquery
-----> Removing helloquery from sharp-mountain-4005... done
Support
The HelloQuery team is here to support you from setup to report building.
We’re happy to help with any request! Please feel free to email us at support@helloquery.com.
Or book a time to talk with an engineer and get your questions answered.