@quillsql/node 0.4.5 → 0.4.7

package/dist/db/CachedConnection.d.ts

@@ -1,12 +1,12 @@
 import { Mapable, CacheCredentials } from "../models/Cache";
-import { DatabaseConnection, QuillDatabaseType } from "./DatabaseHelper";
+import { DatabaseConnection } from "./DatabaseHelper";
 export declare class CachedConnection {
-    databaseType: QuillDatabaseType;
+    databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql";
     pool: DatabaseConnection;
     orgId: any;
     ttl: number;
     cache: Mapable | null;
-    constructor(databaseType: QuillDatabaseType, config: any, cacheConfig?: Partial<CacheCredentials>);
+    constructor(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", config: any, cacheConfig?: Partial<CacheCredentials>);
     query(text: string, values?: any[]): Promise<any>;
     /**
      * Configures and returns a cache instance or null if none could be created.

package/dist/db/DatabaseHelper.d.ts

@@ -6,12 +6,6 @@ import { PostgresConnectionConfig } from "./Postgres";
 import { SnowflakeConnectionConfig } from "./Snowflake";
 import { BigQueryConfig } from "./BigQuery";
 import { MysqlConnectionConfig } from "./Mysql";
-export declare enum QuillDatabaseType {
-    postgresql = "postgresql",
-    snowflake = "snowflake",
-    bigquery = "bigquery",
-    mysql = "mysql"
-}
 export type DatabaseConnection = Pool | snowflake.Connection | BigQuery | MysqlPool;
 export interface QuillQueryResults {
     fields: {
@@ -22,18 +16,18 @@ export interface QuillQueryResults {
         [fieldName: string]: any;
     }[];
 }
-export declare function getDatabaseCredentials(databaseType: QuillDatabaseType, connectionString: string): PostgresConnectionConfig | SnowflakeConnectionConfig | BigQueryConfig | MysqlConnectionConfig | undefined;
-export declare function connectToDatabase(databaseType: QuillDatabaseType, config: PostgresConnectionConfig | SnowflakeConnectionConfig | BigQueryConfig | MysqlConnectionConfig): DatabaseConnection;
-export declare function runQueryByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection, sql: string): Promise<QuillQueryResults> | undefined;
-export declare function disconnectFromDatabase(databaseType: QuillDatabaseType, database: DatabaseConnection): void | Promise<void>;
-export declare function getSchemasByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection): Promise<string[] | undefined>;
-export declare function getTablesBySchemaByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection, schemaName: string | string[]): Promise<string[] | {
+export declare function getDatabaseCredentials(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connectionString: string): PostgresConnectionConfig | SnowflakeConnectionConfig | BigQueryConfig | MysqlConnectionConfig | undefined;
+export declare function connectToDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", config: PostgresConnectionConfig | SnowflakeConnectionConfig | BigQueryConfig | MysqlConnectionConfig): DatabaseConnection;
+export declare function runQueryByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection, sql: string): Promise<QuillQueryResults> | undefined;
+export declare function disconnectFromDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", database: DatabaseConnection): void | Promise<void>;
+export declare function getSchemasByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection): Promise<string[] | undefined>;
+export declare function getTablesBySchemaByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection, schemaName: string | string[]): Promise<string[] | {
     tableName: string;
     schemaName: string;
 }[] | undefined>;
-export declare function getColumnsByTableByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection, schemaName: string, tableName: string): Promise<string[] | undefined>;
-export declare function getForiegnKeysByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection, schemaName: string, tableName: string, primaryKey: string): Promise<string[] | undefined>;
-export declare function getColumnInfoBySchemaByDatabase(databaseType: QuillDatabaseType, connection: DatabaseConnection, schemaName: string, tables: string[] | {
+export declare function getColumnsByTableByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection, schemaName: string, tableName: string): Promise<string[] | undefined>;
+export declare function getForiegnKeysByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection, schemaName: string, tableName: string, primaryKey: string): Promise<string[] | undefined>;
+export declare function getColumnInfoBySchemaByDatabase(databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql", connection: DatabaseConnection, schemaName: string, tables: string[] | {
     tableName: string;
     schemaName: string;
 }[]): Promise<{

package/dist/db/DatabaseHelper.js

@@ -9,18 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getColumnInfoBySchemaByDatabase = exports.getForiegnKeysByDatabase = exports.getColumnsByTableByDatabase = exports.getTablesBySchemaByDatabase = exports.getSchemasByDatabase = exports.disconnectFromDatabase = exports.runQueryByDatabase = exports.connectToDatabase = exports.getDatabaseCredentials = exports.QuillDatabaseType = void 0;
+exports.getColumnInfoBySchemaByDatabase = exports.getForiegnKeysByDatabase = exports.getColumnsByTableByDatabase = exports.getTablesBySchemaByDatabase = exports.getSchemasByDatabase = exports.disconnectFromDatabase = exports.runQueryByDatabase = exports.connectToDatabase = exports.getDatabaseCredentials = void 0;
 const Postgres_1 = require("./Postgres");
 const Snowflake_1 = require("./Snowflake");
 const BigQuery_1 = require("./BigQuery");
 const Mysql_1 = require("./Mysql");
-var QuillDatabaseType;
-(function (QuillDatabaseType) {
-    QuillDatabaseType["postgresql"] = "postgresql";
-    QuillDatabaseType["snowflake"] = "snowflake";
-    QuillDatabaseType["bigquery"] = "bigquery";
-    QuillDatabaseType["mysql"] = "mysql";
-})(QuillDatabaseType || (exports.QuillDatabaseType = QuillDatabaseType = {}));
 function getDatabaseCredentials(databaseType, connectionString) {
     switch (databaseType.toLowerCase()) {
         case "postgres":

package/dist/index.d.ts

@@ -2,7 +2,6 @@ import { CacheCredentials } from "./models/Cache";
 import { QuillQueryParams } from "./models/Quill";
 import { CachedConnection } from "./db/CachedConnection";
 import "dotenv/config";
-import { QuillDatabaseType } from "./db/DatabaseHelper";
 /**
  * Quill - Fullstack API Platform for Dashboards and Reporting.
  */
@@ -15,14 +14,19 @@ export interface QuillQueryResult {
         fields: any[];
     };
 }
-export type DatabaseType = QuillDatabaseType;
+export declare enum DatabaseType {
+    postgresql = "postgresql",
+    snowflake = "snowflake",
+    bigquery = "bigquery",
+    mysql = "mysql"
+}
 export default class QuillClass {
     targetConnection: CachedConnection;
     private baseUrl;
     private config;
     constructor(data: {
         privateKey: string;
-        databaseType: DatabaseType;
+        databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql";
         databaseConnectionString?: string;
         databaseConfig?: any;
         cache?: Partial<CacheCredentials>;

package/dist/index.js

@@ -12,6 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseType = void 0;
 const CachedConnection_1 = require("./db/CachedConnection");
 const axios_1 = __importDefault(require("axios"));
 require("dotenv/config");
@@ -21,6 +22,13 @@ const schemaConversion_1 = require("./utils/schemaConversion");
 const HOST = process.env.ENV === "development"
     ? "http://localhost:8080"
     : "https://quill-344421.uc.r.appspot.com";
+var DatabaseType;
+(function (DatabaseType) {
+    DatabaseType["postgresql"] = "postgresql";
+    DatabaseType["snowflake"] = "snowflake";
+    DatabaseType["bigquery"] = "bigquery";
+    DatabaseType["mysql"] = "mysql";
+})(DatabaseType || (exports.DatabaseType = DatabaseType = {}));
 class QuillClass {
     constructor(data) {
         const { privateKey, databaseType, databaseConnectionString, databaseConfig, cache, metadataServerURL, } = data;
@@ -188,4 +196,4 @@ module.exports.getColumnInfoBySchemaByDatabase =
     DatabaseHelper_1.getColumnInfoBySchemaByDatabase;
 module.exports.connectToDatabase = DatabaseHelper_1.connectToDatabase;
 module.exports.runQueryByDatabase = DatabaseHelper_1.runQueryByDatabase;
-module.exports.DatabaseType = DatabaseHelper_1.QuillDatabaseType;
+module.exports.DatabaseType = DatabaseType;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@quillsql/node",
-  "version": "0.4.5",
-  "description": "Quill's client SDK for node backends.",
+  "version": "0.4.7",
+  "description": "Quill Server SDK for Node.js",
   "main": "dist/index.js",
   "module": "./dist/index.js",
   "types": "dist/index.d.ts",

package/src/db/CachedConnection.ts

@@ -5,7 +5,6 @@ import { createClient } from "redis";
 import { isSuperset } from "../utils/Error";
 import {
   DatabaseConnection,
-  QuillDatabaseType,
   connectToDatabase,
   disconnectFromDatabase,
   runQueryByDatabase,
@@ -29,14 +28,14 @@ class PgError extends Error {
 const DEFAULT_CACHE_TTL = 24 * 60 * 60;
 
 export class CachedConnection {
-  public databaseType: QuillDatabaseType;
+  public databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql";
   public pool: DatabaseConnection;
   public orgId: any;
   public ttl: number;
   public cache: Mapable | null;
 
   constructor(
-    databaseType: QuillDatabaseType,
+    databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
     config: any,
     cacheConfig: Partial<CacheCredentials> = {}
   ) {

package/src/db/DatabaseHelper.ts

@@ -51,13 +51,6 @@ import {
   getSchemasMysql,
 } from "./Mysql";
 
-export enum QuillDatabaseType {
-  postgresql = "postgresql",
-  snowflake = "snowflake",
-  bigquery = "bigquery",
-  mysql = "mysql",
-}
-
 // export all database connections types
 export type DatabaseConnection =
   | Pool
@@ -71,7 +64,7 @@ export interface QuillQueryResults {
 }
 
 export function getDatabaseCredentials(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connectionString: string
 ):
   | PostgresConnectionConfig
@@ -96,7 +89,7 @@ export function getDatabaseCredentials(
 }
 
 export function connectToDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   config:
     | PostgresConnectionConfig
     | SnowflakeConnectionConfig
@@ -120,7 +113,7 @@ export function connectToDatabase(
 }
 
 export function runQueryByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection,
   sql: string
 ): Promise<QuillQueryResults> | undefined {
@@ -141,7 +134,7 @@ export function runQueryByDatabase(
 }
 
 export function disconnectFromDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   database: DatabaseConnection
 ) {
   switch (databaseType.toLowerCase()) {
@@ -161,7 +154,7 @@ export function disconnectFromDatabase(
 }
 
 export async function getSchemasByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection
 ): Promise<string[] | undefined> {
   switch (databaseType.toLowerCase()) {
@@ -182,7 +175,7 @@ export async function getSchemasByDatabase(
 
 // INFORMATION SCHEMA SELECTS
 export async function getTablesBySchemaByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection,
   schemaName: string | string[]
 ): Promise<string[] | { tableName: string; schemaName: string }[] | undefined> {
@@ -219,7 +212,7 @@ export async function getTablesBySchemaByDatabase(
 
 // INFORMATION SCHEMA SELECTS
 export async function getColumnsByTableByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection,
   schemaName: string,
   tableName: string
@@ -261,7 +254,7 @@ export async function getColumnsByTableByDatabase(
 }
 
 export async function getForiegnKeysByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection,
   schemaName: string,
   tableName: string,
@@ -309,7 +302,7 @@ export async function getForiegnKeysByDatabase(
 }
 
 export function getColumnInfoBySchemaByDatabase(
-  databaseType: QuillDatabaseType,
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
   connection: DatabaseConnection,
   schemaName: string,
   tables: string[] | { tableName: string; schemaName: string }[]

package/src/index.ts

@@ -10,7 +10,6 @@ import axios from "axios";
 import "dotenv/config";
 import { mapQueries, removeFields } from "./utils/RunQueryProcesses";
 import {
-  QuillDatabaseType,
   connectToDatabase,
   getColumnInfoBySchemaByDatabase,
   getColumnsByTableByDatabase,
@@ -38,7 +37,13 @@ export interface QuillQueryResult {
   queries?: { rows: any[]; fields: any[] };
 }
 
-export type DatabaseType = QuillDatabaseType;
+export enum DatabaseType {
+  postgresql = "postgresql",
+  snowflake = "snowflake",
+  bigquery = "bigquery",
+  mysql = "mysql",
+}
+
 export default class QuillClass {
   // Configure cached connection pools with the given config.
   public targetConnection;
@@ -51,7 +56,7 @@ export default class QuillClass {
 
   constructor(data: {
     privateKey: string;
-    databaseType: DatabaseType;
+    databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql";
     databaseConnectionString?: string;
     databaseConfig?: any;
     cache?: Partial<CacheCredentials>;
@@ -154,7 +159,7 @@ export default class QuillClass {
 
   private async runQueries(
     queries: string[] | undefined,
-    pkDatabaseType: DatabaseType,
+    pkDatabaseType: "postgresql" | "snowflake" | "bigquery" | "mysql",
     databaseType?: string,
     runQueryConfig?: AdditionalProcessing
   ) {
@@ -271,7 +276,7 @@ const Quill = ({
   privateKey: string;
   databaseConnectionString: string;
   cache?: Partial<CacheCredentials>;
-  databaseType: DatabaseType;
+  databaseType: "postgresql" | "snowflake" | "bigquery" | "mysql";
   databaseConfig: any;
   metadataServerURL?: string;
 }) => {
@@ -297,4 +302,4 @@ module.exports.getColumnInfoBySchemaByDatabase =
   getColumnInfoBySchemaByDatabase;
 module.exports.connectToDatabase = connectToDatabase;
 module.exports.runQueryByDatabase = runQueryByDatabase;
-module.exports.DatabaseType = QuillDatabaseType;
+module.exports.DatabaseType = DatabaseType;