Skip to content

fix(schema-compiler): Avoid ambiguous dimension column mappings for ClickHouse queries #9674

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
11 changes: 11 additions & 0 deletions packages/cubejs-schema-compiler/src/adapter/ClickHouseQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,17 @@ export class ClickHouseQuery extends BaseQuery {
return `ALTER TABLE ${tableName} ADD INDEX ${indexName} (${escapedColumns.join(', ')}) TYPE minmax GRANULARITY 1`;
}

public dimensionColumns(cubeAlias) {
// For the top-level SELECT statement, explicitly set the column alias.
// Clickhouse sometimes includes the "q_0" prefix in the column name, and this
// leads to errors during the result mapping.
if (cubeAlias === 'q_0') {
return this.dimensionAliasNames().map(alias => `${cubeAlias && `${cubeAlias}.` || ''}${alias} ${alias}`);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think checking for cubeAlias inside template string (cubeAlias && ${cubeAlias}. || '') is not necessary, as you can get here only if cubeAlias === 'q_0'

Suggested change
return this.dimensionAliasNames().map(alias => `${cubeAlias && `${cubeAlias}.` || ''}${alias} ${alias}`);
return this.dimensionAliasNames().map(alias => `${cubeAlias}.${alias} ${alias}`);

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to get what the difference between this and impl in baseQuery... Okay, I see.. You add another plain alias without cubeAlias... What if there are more query members from other subqueries with the same plain alias? It seems that it leads to ambiguity, and the query will fail... Nope?

} else {
return super.dimensionColumns(cubeAlias);
}
}

public sqlTemplates() {
const templates = super.sqlTemplates();
templates.functions.DATETRUNC = 'DATE_TRUNC({{ args_concat }})';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
import { prepareJsCompiler } from '../../unit/PrepareCompiler';
import { ClickHouseDbRunner } from './ClickHouseDbRunner';

describe('ClickHouse complex joins', () => {
jest.setTimeout(20 * 1000);

const dbRunner = new ClickHouseDbRunner();

afterAll(async () => {
await dbRunner.tearDown();
});

const { compiler, joinGraph, cubeEvaluator } = prepareJsCompiler(`
cube(\`Acube\`, {
sql: \`SELECT * FROM (SELECT 1 as id, 'Category A' as category, 10 as value UNION ALL
SELECT 2, 'Category B', 20 UNION ALL
SELECT 3, 'Category C', 30) as t\`,

joins: {
Bcube: {
relationship: \`one_to_many\`,
sql: \`\${Acube}.id = \${Bcube}.id\`
},
Ccube: {
relationship: \`one_to_many\`,
sql: \`\${Acube}.id = \${Ccube}.id\`
},
},

measures: {
AcubeCount: {
type: \`count\`,
},
AcubeTotalValue: {
type: \`sum\`,
sql: \`value\`
},
BcubeTotalValue: {
sql: \`\${Bcube.totalValue}\`,
type: \`number\`
},
CcubeTotalAmount: {
sql: \`\${Ccube.totalAmount}\`,
type: \`number\`
},
},

dimensions: {
id: {
sql: \`id\`,
type: \`number\`,
primaryKey: true,
shown: true,
title: \`id\`
},
category: {
sql: \`category\`,
type: \`string\`
}
}
});

cube(\`Bcube\`, {
sql: \`SELECT 1 as id, 'Bgroup1' as groupName, 50 as value UNION ALL
SELECT 2, 'Bgroup2', 60 UNION ALL
SELECT 3, 'Bgroup3', 70\`,

measures: {
count: {
type: \`count\`
},
totalValue: {
type: \`sum\`,
sql: \`value\`
}
},

dimensions: {
id: {
sql: \`id\`,
type: \`number\`,
primaryKey: true
},
groupName: {
sql: \`groupName\`,
type: \`string\`
}
}
});

cube(\`Ccube\`, {
sql: \`SELECT 1 as id, 'Ctype1' as type, 15 as amount UNION ALL
SELECT 2, 'Ctype2', 25 UNION ALL
SELECT 3, 'Ctype3', 35\`,

measures: {
count: {
type: \`count\`
},
totalAmount: {
type: \`sum\`,
sql: \`amount\`
}
},

dimensions: {
id: {
sql: \`id\`,
type: \`number\`,
primaryKey: true,
shown: true
},
type: {
sql: \`type\`,
type: \`string\`
}
}
});
`);

it('query with 1 cube join', async () => dbRunner.runQueryTest(
{
dimensions: [
'Acube.category',
'Acube.id'
],
measures: [
'Acube.AcubeCount',
'Acube.AcubeTotalValue',
'Acube.BcubeTotalValue'
],
order: [{
id: 'Acube.id',
desc: false
}],
queryType: 'multi'
},
[
{
acube__category: 'Category A',
acube__id: '1',
acube___acube_count: '1',
acube___acube_total_value: '10',
acube___bcube_total_value: '50',
},
{
acube__category: 'Category B',
acube__id: '2',
acube___acube_count: '1',
acube___acube_total_value: '20',
acube___bcube_total_value: '60',
},
{
acube__category: 'Category C',
acube__id: '3',
acube___acube_count: '1',
acube___acube_total_value: '30',
acube___bcube_total_value: '70',
}
],
{ joinGraph, cubeEvaluator, compiler }
));

it('query with 2 cube joins', async () => dbRunner.runQueryTest(
{
dimensions: [
'Acube.category',
'Acube.id'
],
measures: [
'Acube.AcubeCount',
'Acube.AcubeTotalValue',
'Acube.BcubeTotalValue',
'Acube.CcubeTotalAmount'
],
order: [{
id: 'Acube.id',
desc: false
}],
queryType: 'multi'
},
[
{
acube__category: 'Category A',
acube__id: '1',
acube___acube_count: '1',
acube___acube_total_value: '10',
acube___bcube_total_value: '50',
acube___ccube_total_amount: '15',
},
{
acube__category: 'Category B',
acube__id: '2',
acube___acube_count: '1',
acube___acube_total_value: '20',
acube___bcube_total_value: '60',
acube___ccube_total_amount: '25',
},
{
acube__category: 'Category C',
acube__id: '3',
acube___acube_count: '1',
acube___acube_total_value: '30',
acube___bcube_total_value: '70',
acube___ccube_total_amount: '35',
}
],
{ joinGraph, cubeEvaluator, compiler }
));
});
Loading