v0.0.18: add simple promise method, fix linting

Author: dforsber

README.md

@@ -9,19 +9,39 @@
 yarn add @boilingdata/node-boilingdata
 ```
 
-## Basic Example
+## Basic Examples
+
+`execQueryPromise()` method can be used to await for the results directly.
+
+```typescript
+import { BoilingData, isDataResponse } from "@boilingdata/node-boilingdata";
+
+async function main() {
+  const bdInstance = new BoilingData({ username: process.env["BD_USERNAME"], password: process.env["BD_PASSWORD"] });
+  await bdInstance.connect();
+  const sql = `SELECT 's3://KEY' AS key, COUNT(*) AS count FROM parquet_scan('s3://KEY');`;
+  const keys = ["s3://boilingdata-demo/demo.parquet", "s3://boilingdata-demo/demo2.parquet"];
+  const rows = await bdInstance.execQueryPromise({ sql, keys });
+  console.log(rows);
+  await bdInstance.close();
+}
+```
+
+`execQuery()` uses callbacks.
 
 ```typescript
 import { BoilingData, isDataResponse } from "@boilingdata/node-boilingdata";
 
 async function main() {
   const bdInstance = new BoilingData({ username: process.env["BD_USERNAME"], password: process.env["BD_PASSWORD"] });
   await bdInstance.connect();
+  const sql = `SELECT 's3://KEY' AS key, COUNT(*) AS count FROM parquet_scan('s3://KEY');`;
+  const keys = ["s3://boilingdata-demo/demo.parquet", "s3://boilingdata-demo/demo2.parquet"];
   const rows = await new Promise<any[]>((resolve, reject) => {
     let r: any[] = [];
     bdInstance.execQuery({
-      sql: `SELECT 's3://KEY' AS key, COUNT(*) AS count FROM parquet_scan('s3://KEY');`,
-      keys: ["s3://boilingdata-demo/demo.parquet", "s3://boilingdata-demo/demo2.parquet"],
+      sql,
+      keys,
       callbacks: {
         onData: (data: IBDDataResponse | unknown) => {
           if (isDataResponse(data)) data.data.map(row => r.push(row));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boilingdata/node-boilingdata",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "BoilingData client",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",

src/boilingdata/boilingdata.ts

@@ -67,7 +67,6 @@ interface IEvent {
 enum ECallbackNames {
   REQUEST = "onRequest",
   ERROR = "onLogError",
-  LOG_MESSAGE = "onLogMessage",
   LOG_INFO = "onLogInfo",
   LOG_ERROR = "onLogError",
   LOG_WARN = "onLogWarn",
@@ -143,8 +142,27 @@ export class BoilingData {
     });
   }
 
+  public execQueryPromise(params: IBDQuery): Promise<any[]> {
+    this.logger.info("execQueryPromise:", params);
+    const r: any[] = [];
+    return new Promise((resolve, reject) => {
+      this.execQuery({
+        sql: params.sql,
+        keys: params.keys || [],
+        engine: params.engine ?? EEngineTypes.DUCKDB,
+        callbacks: {
+          onData: (data: IBDDataResponse | unknown) => {
+            if (isDataResponse(data)) data.data.map(row => r.push(row));
+          },
+          onQueryFinished: () => resolve(r),
+          onLogError: (data: any) => reject(data),
+        },
+      });
+    });
+  }
+
   public execQuery(params: IBDQuery): void {
-    this.logger.info("runQuery:", params);
+    this.logger.info("execQuery:", params);
     this.socketInstance.bumpActivity();
     const requestId = uuidv4();
     const payload: IBDDataQuery = {

src/tests/__snapshots__/query.test.ts.snap

@@ -645,3 +645,48 @@ Array [
   },
 ]
 `;
+
+exports[`boilingdata with promise method can run simple promise based query 1`] = `
+Array [
+  Object {
+    "DOLocationID": 145,
+    "PULocationID": 145,
+    "RatecodeID": 1,
+    "VendorID": 1,
+    "congestion_surcharge": 0,
+    "extra": 0.5,
+    "fare_amount": 3,
+    "improvement_surcharge": 0.3,
+    "mta_tax": 0.5,
+    "passenger_count": 1,
+    "payment_type": 2,
+    "store_and_fwd_flag": "N",
+    "tip_amount": 0,
+    "tolls_amount": 0,
+    "total_amount": 4.3,
+    "tpep_dropoff_datetime": 1556669808000,
+    "tpep_pickup_datetime": 1556669690000,
+    "trip_distance": 0,
+  },
+  Object {
+    "DOLocationID": 145,
+    "PULocationID": 145,
+    "RatecodeID": 1,
+    "VendorID": 1,
+    "congestion_surcharge": 0,
+    "extra": 0.5,
+    "fare_amount": 3,
+    "improvement_surcharge": 0.3,
+    "mta_tax": 0.5,
+    "passenger_count": 1,
+    "payment_type": 2,
+    "store_and_fwd_flag": "N",
+    "tip_amount": 0,
+    "tolls_amount": 0,
+    "total_amount": 4.3,
+    "tpep_dropoff_datetime": 1556671047000,
+    "tpep_pickup_datetime": 1556670954000,
+    "trip_distance": 1.5,
+  },
+]
+`;

src/tests/query.test.ts

@@ -155,6 +155,25 @@ describe("boilingdata with SQLite3", () => {
   });
 });
 
+describe("boilingdata with promise method", () => {
+  beforeAll(async () => {
+    bdInstance = new BoilingData({ username, password, globalCallbacks, logLevel });
+    await bdInstance.connect();
+    logger.info("connected.");
+  });
+
+  afterAll(async () => {
+    await bdInstance.close();
+    logger.info("connection closed.");
+  });
+
+  it("can run simple promise based query", async () => {
+    const sql = `SELECT * FROM parquet_scan('s3://boilingdata-demo/demo2.parquet:m=0') LIMIT 2;`;
+    const results = await bdInstance.execQueryPromise({ sql });
+    expect(results).toMatchSnapshot();
+  });
+});
+
 describe("boilingdata with Glue Tables", () => {
   beforeAll(async () => {
     bdInstance = new BoilingData({ username, password, globalCallbacks, logLevel });