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 (19,563 stars) (1,965 forks)batch import
api:graphqlhelp wanted

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

Tech stack
graphqlrest apirust
Domain
backendapideveloper experience
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Cube's REST /v1/sql endpointGraphQL schema designRust programming (for backend changes)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
First, study the implementation of the REST /v1/sql endpoint in the Cube codebase (likely in Rust backend) to understand how it generates SQL queries. Then, explore the current GraphQL schema (probably in the server/GraphQL directory) to identify where a similar functionality can be added. The issue references issue #4387 which might provide additional context. Since there is no maintainer response, the contributor may need to propose a design in the issue comments before implementing.
GraphQL equivalent API as REST "/v1/sql"? · cube-js/cube#6148 | Good First Issue