cube-js/cube

Add an endpoint to get final SQL query (not parameterized)

Open

#4932 opened on Jul 18, 2022

View on GitHub
 (5 comments) (3 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
help wanted

Description

Is your feature request related to a problem? Please describe. The endpoint /cubejs-api/v1/sql returns a parameterized query which is of no use.

Describe the solution you'd like An endpoint that returns the final SQL request ready to be pasted in DB ide (to debug and test).

Describe alternatives you've considered Manually replace the ? with filters value but it is error prone and tiresome.

Additional context related to https://github.com/cube-js/cube.js/issues/4614

Contributor guide

Tech stack
javascripttypescriptnodejssql
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of Cube.js APIKnowledge of SQL parameterization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue requests a new endpoint like `/cubejs api/v1/sql/raw` that returns the final SQL query with parameters substituted. Currently, the existing `/sql` endpoint returns a parameterized query. To implement, you would need to modify the server code that handles the SQL generation. Refer to the existing implementation in the `cubesql` or `server core` directory. The related issue #4614 may provide context. A new route handler should be added that takes the same parameters as `/sql` but performs parameter substitution before returning. Ensure that the substitution handles all edge cases like list filters.