chore: put primary keys on top in model files (#6861)

Author: vasilev-alex

packages/cubejs-schema-compiler/src/scaffolding/formatters/BaseSchemaFormatter.ts

@@ -121,7 +121,7 @@ export abstract class BaseSchemaFormatter {
       : {
         sql: `SELECT * FROM ${table}`,
       };
-
+      
     return {
       cube: tableSchema.cube,
       ...sqlOption,
@@ -139,7 +139,7 @@ export abstract class BaseSchemaFormatter {
           },
         }))
         .reduce((a, b) => ({ ...a, ...b }), {}),
-      dimensions: tableSchema.dimensions
+      dimensions: tableSchema.dimensions.sort((a) => (a.isPrimaryKey ? -1 : 0))
         .map((m) => ({
           [this.memberName(m)]: {
             sql: this.sqlForMember(m),

packages/cubejs-server-core/src/core/DevServer.ts

@@ -166,7 +166,35 @@ export class DevServer {
       await fs.emptyDir(path.join(schemaPath, 'cubes'));
       await fs.emptyDir(path.join(schemaPath, 'views'));
 
-      await fs.writeFile(path.join(schemaPath, 'views', '.gitkeep'), '');
+      await fs.writeFile(path.join(schemaPath, 'views', 'example_view.yml'), `# In Cube, views are used to expose slices of your data graph and act as data marts.
+# You can control which measures and dimensions are exposed to BIs or data apps, 
+# as well as the direction of joins between the exposed cubes.
+# You can learn more about views in documentation here - https://cube.dev/docs/schema/reference/view
+
+
+# The following example shows a view defined on top of orders and customers cubes. 
+# Both orders and customers cubes are exposed using the "includes" parameter to 
+# control which measures and dimensions are exposed.
+# Prefixes can also be applied when exposing measures or dimensions. 
+# In this case, the customers' city dimension is prefixed with the cube name,
+# resulting in "customers_city" when querying the view.
+
+# views:
+#   - name: example_view
+#
+#     cubes:
+#       - join_path: orders
+#         includes:
+#           - status
+#           - created_date
+#
+#           - total_amount
+#           - count
+#      
+#       - join_path: orders.customers
+#         prefix: true
+#         includes: 
+#           - city`);
       await Promise.all(files.map(file => fs.writeFile(path.join(schemaPath, 'cubes', file.fileName), file.content)));
 
       res.json({ files });