feat(@cubejs-client/core): expose total rows (#7140) (#7372) Thanks @…

…hannosgit!
cube-js · Nov 11, 2023 · a4d08c9 · a4d08c9
1 parent b1da6c0
commit a4d08c9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/cubejs-client-core/index.d.ts b/packages/cubejs-client-core/index.d.ts
@@ -731,6 +731,11 @@ declare module '@cubejs-client/core' {
     query(): Query;
     rawData(): T[];
     annotation(): QueryAnnotations;
+
+    /**
+     * @return the total number of rows if the `total` option was set, when sending the query
+     */
+    totalRows(): number | null;
   }
 
   export type Filter = BinaryFilter | UnaryFilter | LogicalOrFilter | LogicalAndFilter;

diff --git a/packages/cubejs-client-core/src/ResultSet.js b/packages/cubejs-client-core/src/ResultSet.js
@@ -701,6 +701,10 @@ class ResultSet {
     return this.loadResponse.pivotQuery || null;
   }
 
+  totalRows() {
+    return this.loadResponses[0].total;
+  }
+
   rawData() {
     if (this.queryType !== QUERY_TYPE.REGULAR_QUERY) {
       throw new Error(`Method is not supported for a '${this.queryType}' query type. Please use decompose`);