Merge pull request #27 from TileDB-Inc/kostas/sc-11031/improve-performance-in-tiledb-cloud-js

Kostas/sc 11031/improve performance in tiledb cloud js

Author: SarantopoulosKon

.prettierignore

@@ -0,0 +1 @@
+src/fixtures

lib/TileDBQuery/TileDBQuery.d.ts

@@ -1,9 +1,12 @@
-import { ArraySchema, Attribute, Dimension } from "../v1";
-import { AttributeBufferHeader, ConfigurationParameters } from "../v2";
-import { Query } from "../v2";
+import { ArraySchema } from "../v1";
+import { ConfigurationParameters, Query } from "../v2";
+import { Options } from "../utils/getResultsFromArrayBuffer";
 declare type Range = number[] | string[];
-export interface QueryData extends Pick<Query, "layout"> {
+export interface QueryData extends Pick<Query, "layout">, Options {
     ranges: Array<Range | Array<Range>>;
+    /**
+     * Number of bytes allocated to the server for the query.
+     */
     bufferSize: number;
 }
 interface AttributeValue {
@@ -29,7 +32,9 @@ export declare class TileDBQuery {
             originalVarLenBufferSizeInBytes: number;
             originalValidityLenBufferSizeInBytes: number;
         }[];
-        layout: string;
+        layout: string; /**
+         * Number of bytes allocated to the server for the query.
+         */
         status: string;
         type: string;
         writer: {
@@ -149,7 +154,9 @@ export declare class TileDBQuery {
                                 bufferSizes: number[];
                                 bufferStartSizes: number[];
                             }[];
-                        };
+                        }; /**
+                         * Deserialize buffer to a Query object
+                         */
                         start: number;
                         end: number;
                         splitMultiRange: boolean;
@@ -217,7 +224,10 @@ export declare class TileDBQuery {
                 clauses: {
                     fieldName: string;
                     value: number[];
-                    op: string;
+                    op: string; /**
+                     * Since we set the responseType to "arrayBuffer", in case the
+                     * response error message is a buffer, we deserialize the message before throwing
+                     */
                 }[];
                 clauseCombinationOps: string[];
             };
@@ -261,21 +271,13 @@ export declare class TileDBQuery {
             }[];
         };
     }>;
-    ReadIncompleteQuery(arraySchema: ArraySchema, queryAsArrayBuffer: ArrayBuffer, namespace: string, arrayName: string): Promise<{
+    ReadIncompleteQuery(arraySchema: ArraySchema, queryAsArrayBuffer: ArrayBuffer, namespace: string, arrayName: string, options: Options): Promise<{
         query: Query;
         results: Record<string, any>;
         queryAsArrayBuffer: ArrayBuffer;
     }>;
-    ReadQuery(namespace: string, arrayName: string, body: QueryData): AsyncGenerator<Record<string, any>, void, unknown>;
+    ReadQuery(namespace: string, arrayName: string, body: QueryData): AsyncGenerator<{}, void, unknown>;
     private getResultsFromArrayBuffer;
     private throwError;
 }
 export default TileDBQuery;
-/**
- * Convert an ArrayBuffer to a map of attributes with their results
- * @param arrayBuffer The slice ArrayBuffer that contains the results
- * @param attributes
- * @param attributesSchema
- * @returns A map of attribute names with the results of every attribute
- */
-export declare const getResults: (arrayBuffer: ArrayBuffer, attributes: AttributeBufferHeader[], attributesSchema: Array<Dimension | Attribute>) => {};