cube-js/cube

total number of rows available in QueryRenderer and QueryBuilder

Open

#5316 opened on Sep 18, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
help wanted

Description

Is your feature request related to a problem? Please describe. When building data tables with QueryRenderer and QueryBuilder it is necessary to have the total no. of rows available. It is available via /load, but it would make life much easier if its available via the front-end connectors.

Describe the solution you'd like Total number of rows available in resultSet when using QueryRenderer and QueryBuilder.

Describe alternatives you've considered The alternative is to do another call, using the same query, with /load just for the total number of rows.

Additional context I'm using the Vue package (0.29.23), but I assume the discussion extends to React as well.

Contributor guide

Tech stack
javascripttypescriptreactvue
Domain
frontendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of cube js front end packages
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the QueryRenderer and QueryBuilder components in the cube js front end packages (e.g., `@cubejs client/vue` and `@cubejs client/react`). Look at how `resultSet` is currently constructed and returned, and trace the data flow from the `/load` API endpoint. Identify where the total row count is available from the backend but not exposed in the front end result. Consider adding a `totalRows` property to the resultSet object by modifying the relevant TypeScript types and the query result handling logic.