cube-js/cube

Validate column existence in database

Open

#6601 opened on May 15, 2023

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

Description

Hey folks 👋 !

Is your feature request related to a problem? Please describe. As a cube JS user, i am frustrated not being able to confront my cube definition vs actual tables layout in database

Describe the solution you'd like Ideally, a CLI command npx cube-js validate-table-layout would generate 1 SQL query per cube and 1 SQL query per view then dry run (Where 1=2) it against a given database to check column existence

Describe alternatives you've considered I considered to build my own validation using a python script but it's cumberstone and would not benefit cube nor the comunity

Additional context Such feature exist for Looker for example

Contributor guide

Tech stack
javascripttypescriptnodejssql
Domain
backendclidatabasedeveloper 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.
clear
Prerequisites
Knowledge of Cube.js data modelBasic SQLNode.js/TypeScript CLI development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the Cube.js CLI codebase, specifically the commands directory. Look at existing commands for patterns (e.g., /packages/cubejs cli/src/command). The feature requires generating SQL queries for each cube/view and dry running them. Consider using the database adapter from /packages/cubejs backend shared to connect and validate. Review similar features in Looker’s Spectacles for inspiration. Discuss in issue #6601 for any clarifications on scope.