cube-js/cube

Configurable global default for refreshKey

Open

#4649 opened on Jun 1, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
backend:serverhelp wantedloggedreviewed

Description

Unless I specify refreshKey for a particular code, it defaults to 2 minutes for BQ and to 10 seconds for other databases. That is really wasteful in our case. We update analytics once a day, to hitting database after 10 seconds is not necessary, a refreshKey of 'every 1 hour' will be more useful. I can change it for each cube, but this is tedious and error-prone work.

I would like a way to specify default refreshKey in configuration. Either as constant, or maybe as function taking database kind/name/appId/whatever.

I considered manually editing all cubes, but this is fragile - I can miss a cube, or a colleague can add a cube in future without setting refreshKey

Contributor guide

Tech stack
javascripttypescriptnodejs
Domain
backenddataanalytics
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding Cube.js configurationFamiliarity with refreshKey defaults
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Explore the Cube.js configuration schema to locate where refreshKey defaults are defined for each database type. The current defaults are hardcoded (2 minutes for BigQuery, 10 seconds for others). Propose adding a global default configuration option that can be set in the main configuration file, allowing users to override these defaults with a constant or function.