Skip to content

feat(client-core): add CacheMode type #10091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

feat(client-core): add CacheMode type #10091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65dab12
feat(client-core): add CacheMode type
johancube Oct 28, 2025
a8becbf
feat(client-core): add synchronization comment for CacheMode type
johancube Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion packages/cubejs-client-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import ProgressResult from './ProgressResult';
import HttpTransport, { ErrorResponse, ITransport, TransportOptions } from './HttpTransport';
import RequestError from './RequestError';
import {
CacheMode,
ExtractTimeMembers,
LoadResponse,
MetaResponse,
Expand Down Expand Up @@ -107,6 +108,10 @@ export type CubeSqlOptions = LoadMethodOptions & {
* Query timeout in milliseconds
*/
timeout?: number;
/**
* Cache mode for query execution
*/
cache?: CacheMode;
};

export type CubeSqlSchemaColumn = {
Expand Down Expand Up @@ -711,6 +716,7 @@ class CubeApi {
() => {
const request = this.request('cubesql', {
query: sqlQuery,
cache: options?.cache,
method: 'POST',
signal: options?.signal,
fetchTimeout: options?.timeout
Expand Down Expand Up @@ -768,7 +774,8 @@ class CubeApi {
fetchTimeout: options?.timeout,
baseRequestId: uuidv4(),
params: {
query: sqlQuery
query: sqlQuery,
cache: options?.cache
}
});

Expand Down
27 changes: 27 additions & 0 deletions packages/cubejs-client-core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,3 +526,30 @@ export type ProgressResponse = {
stage: string;
timeElapsed: number;
};

// NOTE: This type must be kept in sync with CacheMode in @cubejs-backend/shared (packages/cubejs-backend-shared/src/shared-types.ts)
// This duplication is intentional as @cubejs-client/core does not depend on @cubejs-backend/shared
/**
* Cache mode options for query execution.
*
* - **stale-if-slow** (default): Equivalent to previously used `renewQuery: false`.
* If refresh keys are up-to-date, returns the value from cache.
* If refresh keys are expired, tries to return the value from the database.
* Returns fresh value from the database if the query executed until the first "Continue wait" interval is reached.
* Returns stale value from cache otherwise.
*
* - **stale-while-revalidate**: AKA "backgroundRefresh".
* If refresh keys are up-to-date, returns the value from cache.
* If refresh keys are expired, returns stale data from cache.
* Updates the cache in background.
*
* - **must-revalidate**: Equivalent to previously used `renewQuery: true`.
* If refresh keys are up-to-date, returns the value from cache.
* If refresh keys are expired, tries to return the value from the database.
* Returns fresh value from the database even if it takes minutes and many "Continue wait" intervals.
*
* - **no-cache**: AKA "forceRefresh".
* Skips refresh key checks.
* Returns fresh data from the database, even if it takes minutes and many "Continue wait" intervals.
*/
export type CacheMode = 'stale-if-slow' | 'stale-while-revalidate' | 'must-revalidate' | 'no-cache';
Loading