cube-js/cube

GraphQL equivalent API as REST "/v1/sql"?

Open

#6,148 opened on Feb 12, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (1,965 forks)batch import
api:graphqlhelp wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 5d 16h) (138 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe. REST have /v1/sql API to get the SQL Code generated by Cube to be executed in the database. https://cube.dev/docs/rest-api#api-reference-v-1-sql

However, for a GraphQL query, there seems no equivalent API. It is a nice to have feature, maybe helpful to debug whether the query is expected. e.g. https://github.com/cube-js/cube.js/issues/4387 (btw, playground may help, but for production, playground is normally turn off)

Describe the solution you'd like GraphQL equivalent API as REST "/v1/sql". Still /graphql endpoint, but provide a different query type?

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Contributor guide

Research direction
Examine the existing /v1/sql REST endpoint implementation to understand how it generates SQL code. Then design a similar GraphQL query or mutation that returns the SQL equivalent for a given GraphQL query. Look at the GraphQL schema definitions and resolvers to see where to add this feature.
Tech stack
None
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGraphQLREST
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60