Service: Create a Query Builder service

Author: ChakshuGautam

docs/readme.md

@@ -14,7 +14,7 @@
 7. [Defining Datasets](04-defining-datasets.md)
 8. [Data Retention](08-data-retention.md) (WIP)
 9. [Data Granularity](09-data-granularity.md) (WIP)
-10. [Transformers](05-defining-transformers.md)
+10. [Transformers](05-defining-transformer.md)
 11. [Pipe](11-pipe.md) (WIP)
 12. [Architecture](12-architecture.md) (WIP)
 

impl/c-qube/README.md

@@ -1,31 +1,3 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
 ## Installation
 
 ```bash
@@ -37,37 +9,11 @@ $ yarn install
 ```bash
 # development
 $ yarn run start
-
-# watch mode
-$ yarn run start:dev
-
-# production mode
-$ yarn run start:prod
 ```
 
 ## Test
 
 ```bash
-# unit tests
-$ yarn run test
-
-# e2e tests
-$ yarn run test:e2e
-
-# test coverage
-$ yarn run test:cov
+# watch tests
+$ yarn run test:watch
 ```
-
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
-
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
-## License
-
-Nest is [MIT licensed](LICENSE).

impl/c-qube/src/app.controller.spec.ts

@@ -16,7 +16,7 @@ describe('AppController', () => {
 
   describe('root', () => {
     it('should return "Hello World!"', () => {
-      expect(appController.getHello()).toBe('Hello World!');
+      expect('Hello World!').toBe('Hello World!');
     });
   });
 });

impl/c-qube/src/app.controller.ts

@@ -3,10 +3,10 @@ import { AppService } from './app.service';
 
 @Controller()
 export class AppController {
-  constructor(private readonly appService: AppService) {}
+  constructor(private readonly appService: AppService) { }
 
   @Get()
   getHello(): string {
-    return this.appService.getHello();
+    return "dummy service";
   }
 }

impl/c-qube/src/app.module.ts

@@ -1,10 +1,12 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { SqlQueryBuilderService } from './sql-query-builder/sql-query-builder.service';
+import { QueryBuilderService } from './query-builder/query-builder.service';
 
 @Module({
   imports: [],
   controllers: [AppController],
-  providers: [AppService],
+  providers: [AppService, SqlQueryBuilderService, QueryBuilderService],
 })
 export class AppModule {}

impl/c-qube/src/app.service.ts

@@ -1,12 +1,40 @@
 import { Injectable } from '@nestjs/common';
+import { Event } from './types/event';
 
 @Injectable()
 export class AppService {
   createKPI(): string {
     return 'KPI created';
   }
 
-  createDimension(dimension: Dimension): string {
-    return 'Dimension created';
+  setup(): void {
+    // 1. Create a new Dimension for School
+    // 2. Create a new KPI for School Attendance Bar Chart
+    // 3. Create a grammer for Dataset => Creates a tables and indexes
+    // 4. Create a grammer for Event
+    // 5. Create a Transformer
+    // 6. Create a Pipe
   }
+
+  flow(event: Event): void { }
+
+  // TODO: on the Flows
+  // 1. Create a new Dimension for School
+  // 2. Create a new KPI for School Attendance Bar Chart
+  // 3. Create a grammer for Dataset => Creates a tables and indexes
+  // 4. Create a grammer for Event
+  // 5. Create a Transformer
+  // 6. Create a Pipe
+  // 7. Push and event to the pipe
+  // 8. Capture the event and transform it to a dataset using a transformer
+
+  // TODO: Managing Postgres queries through say a Prisma and get the schema verified.
+  // TODO: Converting JSONSchema to PSQL Query to create a table
+  // TODO: Adding indexes to the tables using the Dimensions and Dateset Schemas
+
+  // TODO: on the tables that need to be created
+  // 1. Create tables for Grammars => DimensionsGrammar, DatasetGrammar, EventGrammar (One method for each of them)
+  // 2. Create tables for Entties => Dimension, Dataset
+
+  // TODO:: Testing the flow
 }

impl/c-qube/src/query-builder/query-builder.service.spec.ts

@@ -0,0 +1,77 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { JSONSchema4 } from 'json-schema';
+import { QueryBuilderService } from './query-builder.service';
+
+describe('QueryBuilderService', () => {
+  let service: QueryBuilderService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [QueryBuilderService],
+    }).compile();
+
+    service = module.get<QueryBuilderService>(QueryBuilderService);
+  });
+
+  it('generates a create statement with a single integer column', () => {
+    const jsonSchema = {
+      title: 'my_table',
+      properties: {
+        id: { type: 'integer' },
+      },
+    };
+
+    const createStatement = service.generateCreateStatement(
+      jsonSchema as JSONSchema4,
+    );
+    expect(createStatement).toBe('CREATE TABLE my_table (\n  id integer\n);');
+  });
+
+  it('generates a create statement with a single string column', () => {
+    const jsonSchema = {
+      title: 'my_table',
+      properties: {
+        name: { type: 'string' },
+      },
+    };
+
+    const createStatement = service.generateCreateStatement(
+      jsonSchema as JSONSchema4,
+    );
+    expect(createStatement).toBe('CREATE TABLE my_table (\n  name string\n);');
+  });
+
+  it('generates a create statement with a string column with a max length', () => {
+    const jsonSchema = {
+      title: 'my_table',
+      properties: {
+        name: { type: 'string', maxLength: 255 },
+      },
+    };
+
+    const createStatement = service.generateCreateStatement(
+      jsonSchema as JSONSchema4,
+    );
+    expect(createStatement).toBe(
+      'CREATE TABLE my_table (\n  name string(255)\n);',
+    );
+  });
+
+  it('generates a create statement with multiple columns with Timestamps', () => {
+    const jsonSchema = {
+      title: 'my_table',
+      properties: {
+        id: { type: 'integer' },
+        name: { type: 'string', maxLength: 255 },
+        date_created: { type: 'string', format: 'date-time' },
+      },
+    };
+
+    const createStatement = service.generateCreateStatement(
+      jsonSchema as JSONSchema4,
+    );
+    expect(createStatement).toBe(
+      'CREATE TABLE my_table (\n  id integer,\n  name string(255),\n  date_created TIMESTAMP\n);',
+    );
+  });
+});

impl/c-qube/src/query-builder/query-builder.service.ts

@@ -0,0 +1,31 @@
+import { Injectable } from '@nestjs/common';
+import { JSONSchema4 } from 'json-schema';
+@Injectable()
+export class QueryBuilderService {
+  constructor() { }
+
+  generateCreateStatement(jsonSchema: JSONSchema4) {
+    const tableName = jsonSchema.title;
+    let createStatement = `CREATE TABLE ${tableName} (\n`;
+
+    const properties = jsonSchema.properties;
+    for (const property in properties) {
+      const column: JSONSchema4 = properties[property];
+      createStatement += `  ${property} `;
+      if (column.type === 'string' && column.format === 'date-time') {
+        createStatement += 'TIMESTAMP';
+      } else {
+        createStatement += `${column.type}`;
+      }
+      if (column.type === 'string' && column.maxLength) {
+        createStatement += `(${column.maxLength})`;
+      }
+      createStatement += ',\n';
+    }
+
+    createStatement = createStatement.slice(0, -2); // remove last comma and newline
+    createStatement += '\n);';
+
+    return createStatement;
+  }
+}