cube-js/cube

Utilise database comments on tables (and fields) to populate descriptions in Cube

Open

#4,707 opened on Jun 4, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (1,965 forks)batch import
help wantedloggedreviewed

Repository metrics

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

Description

Problem

When generating a schema in Cube, is it possible to leverage the existing database table & columns' comments to populate the descriptions parameter on cubes? I’m a big fan of descriptions within the database (I generate these via dbt) and an example I have is pictured below (a Redshift table DDL):

Contributor guide

Research direction
Investigate how Cube currently generates schemas and identify where to inject database comment metadata.
Tech stack
javascripttypescript
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScriptSQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65