Waii API Changelog - Version 1.3.0

Diff and explain

New Features:

1. Explain Query API:

Ever looked at a long SQL query and felt like you were deciphering hieroglyphics? Well, no more! Presenting the Explain Query API that takes your SQL and translates it into plain English, giving you both the "what" and the "how" behind each statement.

Key Benefits:

  1. Fast Understanding: Get a clear English description of what the SQL query does, aiding in easier comprehension.
  2. Step-by-Step Walkthrough: Beyond just an overview, the API breaks down the query, explaining each step and logic in the process.
  3. Simplify workload maintenance: Teams inheriting SQL scripts from predecessors will find this tool invaluable, making it simpler to manage and adapt existing queries.

How it Works:

Given SQL Query:

RANK() OVER (PARTITION BY department ORDER BY salary DESC) as rank_in_department,
AVG(salary) OVER (PARTITION BY department) as avg_department_salary
hire_date > '2020-01-01'
department, rank_in_department;

Upon feeding this into the Explain Query API, you might get:

"This query fetches details about employees who were hired after January 1, 2020. Specifically, for each employee, we retrieve their department, employee ID, and salary. Additionally, for each employee, we're computing two special metrics:
1. Their rank within their respective department based on theirsalary. This means if an employee has the highest salary intheir department, they will be ranked as number one, and soon.
2. The average salary for their respective department. The results are organized by department, and within each department, employees are sorted based on their rank, i.e., from the highest to the lowest salary."

The Explain Query API can deconstruct even intricate SQL statements, offering both the overarching intention behind the query and a granular breakdown of its components.

Navigating changes in SQL scripts can be a daunting task, especially with undocumented modifications. Enter the Diff Query API, your new assistant in recognizing and comprehending the disparities between two SQL queries.

Key Benefits:

  1. Spot the Differences: Quickly identify variations between two similar SQL statements.
  2. Clarify Undocumented Changes: Gain insight into modifications, especially when change logs or documentation are absent.
  3. Seamless Integration: The availability via CLI ensures this tool fits effortlessly into your existing workflow, facilitating regular checks and updates.

How it Works:

Imagine you have two versions of a seemingly similar query:

Query A:

SELECT department, COUNT(employee_id) as total_employees
FROM employees
WHERE department != 'Temp'
GROUP BY department
ORDER BY total_employees DESC;

Query B:

SELECT department, COUNT(DISTINCT employee_id) as total_employees
FROM employees
JOIN salaries ON employees.employee_id = salaries.emp_id
WHERE department != 'Temp' AND salaries.salary > 50000
GROUP BY department
ORDER BY total_employees DESC;

Upon feeding these into the Diff Query API, you might receive:

"Both queries aim to count employees by department, excluding the 'Temp' department, and present the results in descending order based on the total count. However, while Query A counts all employees, Query B only counts distinct employees, effectively filtering out any duplicates. Additionally, Query B is only considering employees with a salary greater than 50,000 by joining with the 'salaries' table."

The combination of Explain and Diff promises to revolutionize the way teams understand, maintain, and evolve their SQL workloads. As some of our users have aptly mentioned, understanding existing SQL might just be more pivotal than creating new ones. Dive in, explore, and let these new tools illuminate your SQL journey!

Thank you for being a pivotal part of the Waii community. Your insights drive our innovation. Let's keep the conversation going and make SQL more intuitive for everyone!

Get started with Waii today!

For an enterprise-level implementation, we offer competitive consumption-based pricing, billed either monthly or annually.

Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.