fix: Handle primaryKey shown: false pitfall error

paveltiunov · paveltiunov · commit 5bbf5f09b607 · 2020-02-25T16:16:17.000-08:00
diff --git a/packages/cubejs-api-gateway/index.js b/packages/cubejs-api-gateway/index.js
@@ -70,7 +70,7 @@ const transformData = (aliasToMemberNameMap, annotation, data, query) => (data.m
     const memberName = aliasToMemberNameMap[p[0]];
     const annotationForMember = annotation[memberName];
     if (!annotationForMember) {
-      throw new UserError(`You requested hidden member: '${p[0]}'. Please make it visible using \`shown: true\``);
+      throw new UserError(`You requested hidden member: '${p[0]}'. Please make it visible using \`shown: true\`. Please note primaryKey fields are \`shown: false\` by default: https://cube.dev/docs/joins#setting-a-primary-key.`);
     }
     const transformResult = [
       memberName,

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ const transformData = (aliasToMemberNameMap, annotation, data, query) => (data.m`
`70`	`70`	`const memberName = aliasToMemberNameMap[p[0]];`
`71`	`71`	`const annotationForMember = annotation[memberName];`
`72`	`72`	`if (!annotationForMember) {`
`73`		- throw new UserError(`You requested hidden member: '${p[0]}'. Please make it visible using \`shown: true\``);
	`73`	+ throw new UserError(`You requested hidden member: '${p[0]}'. Please make it visible using \`shown: true\`. Please note primaryKey fields are \`shown: false\` by default: https://cube.dev/docs/joins#setting-a-primary-key.`);
`74`	`74`	`}`
`75`	`75`	`const transformResult = [`
`76`	`76`	`memberName,`