Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions packages/cubejs-api-gateway/src/graphql.ts
Original file line number Diff line number Diff line change
Expand Up @@ -426,9 +426,11 @@ export function getJsonQuery(metaConfig: any, args: Record<string, any>, infos:
if (granularityName === 'value') {
dimensions.push(key);
} else {
const offsetArg = getArgumentValue(granularityNode, 'offset', infos.variableValues);
timeDimensions.push({
dimension: key,
granularity: granularityName,
...(offsetArg ? { offset: offsetArg } : null),
...(dateRangeFilters[key] ? {
dateRange: dateRangeFilters[key],
} : null)
Expand Down
8 changes: 7 additions & 1 deletion packages/cubejs-api-gateway/src/query.js
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,18 @@ const querySchema = Joi.object().keys({
timeDimensions: Joi.array().items(Joi.object().keys({
dimension: id.required(),
granularity: Joi.string().max(128, 'utf8'), // Custom granularities may have arbitrary names
offset: Joi.string().max(128, 'utf8'), // Query-time granularity offset
dateRange: [
Joi.array().items(Joi.string()).min(1).max(2),
Joi.string()
],
compareDateRange: Joi.array()
}).oxor('dateRange', 'compareDateRange')),
}).oxor('dateRange', 'compareDateRange').custom((value, helpers) => {
if (value.offset && !value.granularity) {
return helpers.error('any.invalid', { message: 'offset can only be specified when granularity is also specified' });
}
return value;
})),
order: Joi.alternatives(
Joi.object().pattern(idOrMemberExpressionName, Joi.valid('asc', 'desc')),
Joi.array().items(Joi.array().min(2).ordered(idOrMemberExpressionName, Joi.valid('asc', 'desc')))
Expand Down
1 change: 1 addition & 0 deletions packages/cubejs-api-gateway/src/types/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ interface QueryTimeDimension {
dateRange?: string[] | string;
compareDateRange?: string[];
granularity?: QueryTimeDimensionGranularity;
offset?: string;
}

type SubqueryJoins = {
Expand Down
1 change: 1 addition & 0 deletions packages/cubejs-client-core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export interface TimeDimensionBase {
dimension: string;
granularity?: TimeDimensionGranularity;
dateRange?: DateRange;
offset?: string;
}

export interface TimeDimensionComparison extends TimeDimensionBase {
Expand Down
3 changes: 3 additions & 0 deletions packages/cubejs-client-dx/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ declare module "@cubejs-client/core" {

export interface TimeDimensionBase {
dimension: IntrospectedTimeDimensionName;
granularity?: TimeDimensionGranularity;
dateRange?: DateRange;
offset?: string;
}

export interface BinaryFilter {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ export class TimeDimensionMember {
this.updateTimeDimension(by, { granularity });
}

setOffset(by: string | number, offset: string) {
this.updateTimeDimension(by, { offset });
}

asArray(): any[] {
return (this.query.asCubeQuery().timeDimensions || []).map((td) => {
return {
Expand Down
17 changes: 17 additions & 0 deletions packages/cubejs-schema-compiler/src/adapter/Granularity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,23 @@ export class Granularity {
this.queryTimezone = query.timezone || 'UTC';
this.origin = moment.tz(query.timezone).startOf('year'); // Defaults to current year start

// Query-time offset takes precedence over data model offset
const queryTimeOffset = timeDimension.offset;

if (this.predefinedGranularity) {
this.granularityInterval = `1 ${this.granularity}`;
// Support query-time offset for predefined granularities
if (queryTimeOffset) {
this.fixOriginForWeeksIfNeeded();
// Validate offset format
try {
const parsedOffset = parseSqlInterval(queryTimeOffset);
this.granularityOffset = queryTimeOffset;
this.origin = addInterval(this.origin, parsedOffset);
} catch (e) {
throw new Error(`Invalid offset format "${queryTimeOffset}". Expected SQL interval format like "2 hours", "-30 minutes", or "1 day 2 hours"`);
}
}
} else {
const customGranularity = this.query.cacheValue(
['customGranularity', timeDimension.dimension, this.granularity],
Expand All @@ -51,6 +66,8 @@ export class Granularity {

if (customGranularity.origin) {
this.origin = moment.tz(customGranularity.origin, query.timezone);
} else if (queryTimeOffset) {
throw new Error(`Query-time offset parameter cannot be used with custom granularity "${this.granularity}". Offset is only supported with predefined granularities (day, week, month, etc.)`);
} else if (customGranularity.offset) {
// Needed because if interval is week-based, offset is expected to be relative to the start of a week
this.fixOriginForWeeksIfNeeded();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ describe('Custom Granularities', () => {
- name: two_weeks_by_friday
interval: 2 weeks
origin: '2024-08-23'
- name: one_week_by_friday_by_offset
interval: 1 week
offset: 4 days
- name: one_hour_by_5min_offset
interval: 1 hour
offset: 5 minutes
Expand Down Expand Up @@ -564,4 +567,147 @@ describe('Custom Granularities', () => {
],
{ joinGraph, cubeEvaluator, compiler }
));

// Query-time offset tests

// Test demonstrating day boundaries shifted to 2am-2am
it('works with query-time offset shifting day boundary (2am-2am)', async () => {
const { compiler: offsetCompiler, joinGraph: offsetJoinGraph, cubeEvaluator: offsetCubeEvaluator } = prepareYamlCompiler(`
cubes:
- name: events
sql: >
SELECT *
FROM (
SELECT 1 as event_id, toDateTime('2024-01-01 00:00:00') as event_time UNION ALL
SELECT 2, toDateTime('2024-01-01 01:00:00') UNION ALL
SELECT 3, toDateTime('2024-01-01 01:30:00') UNION ALL
SELECT 4, toDateTime('2024-01-02 00:00:00') UNION ALL
SELECT 5, toDateTime('2024-01-02 01:00:00') UNION ALL
SELECT 6, toDateTime('2024-01-02 01:30:00')
)

dimensions:
- name: event_id
sql: event_id
type: number
primary_key: true

- name: eventTime
sql: event_time
type: time

measures:
- name: count
type: count
`);

await dbRunner.runQueryTest(
{
measures: ['events.count'],
timeDimensions: [{
dimension: 'events.eventTime',
granularity: 'day',
offset: '2 hours',
dateRange: ['2024-01-01', '2024-01-03']
}],
dimensions: [],
timezone: 'UTC',
order: [['events.eventTime', 'asc']],
},
[
{
events__event_time_day: '2023-12-31T02:00:00.000',
events__count: '3',
},
{
events__event_time_day: '2024-01-01T02:00:00.000',
events__count: '3',
},
],
{ joinGraph: offsetJoinGraph, cubeEvaluator: offsetCubeEvaluator, compiler: offsetCompiler }
);
});

// Test demonstrating week boundaries shifted to Wednesday-Wednesday
it('works with query-time offset shifting week to start on Wednesday', async () => {
const { compiler: weekCompiler, joinGraph: weekJoinGraph, cubeEvaluator: weekCubeEvaluator } = prepareYamlCompiler(`
cubes:
- name: activities
sql: >
SELECT *
FROM (
SELECT 1 as activity_id, toDateTime('2024-01-01 10:00:00') as activity_time UNION ALL
SELECT 2, toDateTime('2024-01-02 10:00:00') UNION ALL
SELECT 3, toDateTime('2024-01-03 10:00:00') UNION ALL
SELECT 4, toDateTime('2024-01-04 10:00:00') UNION ALL
SELECT 5, toDateTime('2024-01-08 10:00:00') UNION ALL
SELECT 6, toDateTime('2024-01-10 10:00:00')
)

dimensions:
- name: activity_id
sql: activity_id
type: number
primary_key: true

- name: activityTime
sql: activity_time
type: time

measures:
- name: count
type: count
`);

await dbRunner.runQueryTest(
{
measures: ['activities.count'],
timeDimensions: [{
dimension: 'activities.activityTime',
granularity: 'week',
offset: '2 days',
dateRange: ['2024-01-01', '2024-01-15']
}],
dimensions: [],
timezone: 'UTC',
order: [['activities.activityTime', 'asc']],
},
[
{
activities__activity_time_week: '2024-01-03T00:00:00.000',
activities__count: '3',
},
{
activities__activity_time_week: '2024-01-10T00:00:00.000',
activities__count: '1',
},
{
activities__activity_time_week: '2023-12-27T00:00:00.000',
activities__count: '2',
},
],
{ joinGraph: weekJoinGraph, cubeEvaluator: weekCubeEvaluator, compiler: weekCompiler }
);
});

it('rejects query-time offset with custom granularity', async () => {
await expect(
dbRunner.runQueryTest(
{
measures: ['orders.count'],
timeDimensions: [{
dimension: 'orders.createdAt',
granularity: 'one_week_by_friday_by_offset',
offset: '2 days',
dateRange: ['2024-01-01', '2024-02-28']
}],
dimensions: [],
timezone: 'UTC',
order: [['orders.createdAt', 'asc']],
},
[],
{ joinGraph, cubeEvaluator, compiler }
)
).rejects.toThrow('Query-time offset parameter cannot be used with custom granularity');
});
});
Loading
Loading