GitHub Issue 1534: Cap row counts for React grid pagination

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/api",
-  "version": "1.52.4",
+  "version": "1.52.5-fb-limitMaxCount.1",
   "description": "JavaScript client API for LabKey Server",
   "scripts": {
     "build": "npm run build:dist && npm run build:docs",

src/labkey/query/ExecuteSql.ts

@@ -39,6 +39,11 @@ export interface ExecuteSqlOptions extends RequestCallbackOptions {
      * If false totalCount will equal number of rows returned (equal to maxRows unless maxRows == 0).
      */
     includeTotalCount?: boolean;
+    /**
+     * Cap the total-count query at this many rows so COUNT(*) is performant. When exceeded the response reports
+     * rowCount clamped to this value and rowCountCapped: true. Omitted or 0 counts exactly (the default).
+     */
+    maxCount?: number;
     /** The maximum number of rows to return from the server (defaults to returning 100,000 rows). */
     maxRows?: number;
     /**
@@ -117,6 +122,9 @@ function buildParams(options: ExecuteSqlOptions): any {
     if (options.includeTotalCount !== undefined) {
         jsonData.includeTotalCount = options.includeTotalCount;
     }
+    if (options.maxCount !== undefined) {
+        jsonData.maxCount = options.maxCount;
+    }
 
     if (options.containerFilter) {
         jsonData.containerFilter = options.containerFilter;

src/labkey/query/Response.ts

@@ -178,6 +178,8 @@ export class Response {
     metaData: ResponseMetadata;
     queryName: string;
     rowCount: number;
+    /** True when rowCount was capped at the request's maxCount rather than counted exactly. Absent unless maxCount was hit. */
+    rowCountCapped?: boolean;
     rows: Row[];
     schemaKey: SchemaKey;
     schemaName: string;

src/labkey/query/SelectRows.ts

@@ -63,6 +63,12 @@ export interface SelectRowsOptions extends RequestCallbackOptions {
      * number of rows returned (equal to maxRows unless maxRows == 0).
      */
     includeTotalCount?: boolean;
+    /**
+     * Cap the total-count query at this many rows, so a large grid's COUNT(*) won't do a full scan.
+     * When exceeded the response reports rowCount clamped to this value and rowCountCapped: true. Omitted or 0
+     * counts exactly (the default). Only affects the count; row data is unaffected.
+     */
+    maxCount?: number;
     /**
      * Include the Update (or edit) link column in the set of columns (defaults to false). If included, the column
      * will have the name "~~Update~~". The underlying table/query must support update links or the column
@@ -172,6 +178,8 @@ function buildSelectRowsParams(options: SelectRowsOptions): any {
 
     if (options.includeTotalCount !== undefined) params.includeTotalCount = options.includeTotalCount;
 
+    if (options.maxCount !== undefined) params.maxCount = options.maxCount;
+
     if (options.includeDetailsColumn) params.includeDetailsColumn = options.includeDetailsColumn;
 
     if (options.includeUpdateColumn) params.includeUpdateColumn = options.includeUpdateColumn;