Merge pull request #93 from ThePrez/fix/tersedata

Handle terse data format from server for SQL results

Author: worksofliam

src/connection/manager.ts

@@ -90,7 +90,16 @@ export class SQLJobManager {
     return (this.selectedJob >= 0);
   }
 
-  async runSQL<T>(query: string, opts: QueryOptions = {}): Promise<T[]> {
+  /**
+   * Runs SQL
+   * @param query the SQL query
+   * @param parameters the list of parameters (indicated by '?' parameter parkers in the SQL query)
+   * @param isTerseResults whether the returned data is in terse format. When set to true, the data is returned as an array
+   * of arrays. When set to false, data is returned as an array of objects (compatible with legacy API).
+   * @returns 
+   */
+  async runSQL<T>(query: string, opts?: QueryOptions): Promise<T[]> {
+
     // 2147483647 is NOT arbitrary. On the server side, this is processed as a Java
     // int. This is the largest number available without overflow (Integer.MAX_VALUE)
     const rowsToFetch = 2147483647;

src/connection/query.ts

@@ -16,6 +16,7 @@ export class Query<T> {
   private rowsToFetch: number = 100;
   private isCLCommand: boolean;
   private state: QueryState = QueryState.NOT_YET_RUN;
+  private isTerseResults: boolean;
 
   public shouldAutoClose: boolean;
 
@@ -26,6 +27,7 @@ export class Query<T> {
     this.sql = query;
     this.isCLCommand = opts.isClCommand;
     this.shouldAutoClose = opts.autoClose;
+    this.isTerseResults = opts.isTerseResults;
 
     Query.globalQueryList.push(this);
   }
@@ -70,13 +72,15 @@ export class Query<T> {
       queryObject = {
         id: SQLJob.getNewUniqueId(`clcommand`),
         type: `cl`,
+        terse: this.isTerseResults,
         cmd: this.sql
       };
     } else {
       queryObject = {
         id: SQLJob.getNewUniqueId(`query`),
         type: this.isPrepared ? `prepare_sql_execute` : `sql`,
         sql: this.sql,
+        terse: this.isTerseResults,
         rows: rowsToFetch,
         parameters: this.parameters
       };

src/connection/types.ts

@@ -29,6 +29,7 @@ export enum ServerTraceDest {
   IN_MEM = "IN_MEM"
 }
 export interface QueryOptions {
+  isTerseResults?: boolean;
   isClCommand?: boolean,
   parameters?: any[],
   autoClose?: boolean

src/testing/jobs.ts

@@ -99,7 +99,38 @@ export const JobsSuite: TestSuite = {
 
       newJob.close();
     }},
+    {name: `Query with non-terse results`, test: async () => {
+      assert.strictEqual(ServerComponent.isInstalled(), true);
+
+      let newJob = new SQLJob({libraries: [`QIWS`], naming: `system`});
+      await newJob.connect();
 
+      let rowsAtATime = 4;
+      let qry = newJob.query(`select * from QIWS.QCUSTCDT limit 1`,{isTerseResults: false});
+      let qryResults = await qry.run(rowsAtATime);
+
+      assert.equal(qryResults.success, true);
+      let firstRow = qryResults.data[0];
+      let cusnum = firstRow[`CUSNUM`];
+      assert.equal(cusnum === undefined, false);
+      assert.equal(Array.isArray(firstRow), false);
+      newJob.close();
+    }},
+    {name: `Query with terse results`, test: async () => {
+      assert.strictEqual(ServerComponent.isInstalled(), true);
+
+      let newJob = new SQLJob({libraries: [`QIWS`], naming: `system`});
+      await newJob.connect();
+
+      let rowsAtATime = 4;
+      let qry = newJob.query(`select * from QIWS.QCUSTCDT limit 1`,{isTerseResults: true});
+      let qryResults = await qry.run(rowsAtATime);
+
+      assert.equal(qryResults.success, true);
+      let firstRow = qryResults.data[0];
+      assert.equal(Array.isArray(firstRow), true);
+      newJob.close();
+    }},
     {name: `Can round-trip Extended characters`, test: async () => {
       assert.strictEqual(ServerComponent.isInstalled(), true);
 

src/views/results/html.ts

@@ -54,7 +54,6 @@ export function generateScroller(basicSelect: string, isCL: boolean): string {
           let totalRows = 0;
           let noMoreRows = false;
           let isFetching = false;
-          let columnList = [];
 
           window.addEventListener("load", main);
             function main() {
@@ -82,17 +81,14 @@ export function generateScroller(basicSelect: string, isCL: boolean): string {
                   isFetching = false;
                   noMoreRows = data.isDone;
 
-                  if (mustLoadHeaders) {
-                    columnList = event.data.columnList;
-                    
-                    setHeaders('resultset', columnList);
-
+                  if (mustLoadHeaders && event.data.columnList) {
+                    setHeaders('resultset', event.data.columnList);
                     mustLoadHeaders = false;
                   }
 
                   if (data.rows && data.rows.length > 0) {
                     totalRows += data.rows.length;
-                    appendRows('resultset', columnList, data.rows);
+                    appendRows('resultset', data.rows);
                   }
 
                   const nextButton = document.getElementById("nextButton");
@@ -141,19 +137,19 @@ export function generateScroller(basicSelect: string, isCL: boolean): string {
             });
           }
 
-          function appendRows(tableId, colList, arrayOfObjects) {
+          function appendRows(tableId, arrayOfObjects) {
             var tBodyRef = document.getElementById(tableId).getElementsByTagName('tbody')[0];
 
             for (const row of arrayOfObjects) {
               // Insert a row at the end of table
               var newRow = tBodyRef.insertRow();
 
-              for (const columnName of colList) {
+              for (const cell of row) {
                 // Insert a cell at the end of the row
                 var newCell = newRow.insertCell();
 
                 // Append a text node to the cell
-                var newText = document.createTextNode(row[columnName] === undefined ? 'null' : row[columnName]);
+                var newText = document.createTextNode(cell === undefined ? 'null' : cell);
                 newCell.appendChild(newText);
               }
             }

src/views/results/index.ts

@@ -41,7 +41,7 @@ class ResultSetPanelProvider {
             // We will need to revisit this if we ever allow multiple result tabs like ACS does
             Query.cleanup();
 
-            let query = await JobManager.getPagingStatement(message.query, { isClCommand: message.isCL, autoClose: true });
+            let query = await JobManager.getPagingStatement(message.query, { isClCommand: message.isCL, autoClose: true, isTerseResults: true });
             queryObject = query;
           }
 
@@ -161,7 +161,7 @@ export function initialise(context: vscode.ExtensionContext) {
 
                 } else {
                   // Otherwise... it's a bit complicated.
-                  const data = await JobManager.runSQL(statement.content);
+                  const data = await JobManager.runSQL(statement.content, undefined, true);
 
                   if (data.length > 0) {
                     switch (statement.type) {