Uploaded image for project: 'RAML Module Builder'
  1. RAML Module Builder
  2. RMB-578

Inform whether totalRecords is exact or an estimate

    XMLWordPrintable

Details

    • New Feature
    • Status: Blocked (View Workflow)
    • P2
    • Resolution: Unresolved
    • None
    • None
    • CP: Non-roadmap backlog, CP: sprint 94, CP: sprint 95, CP: sprint 96, CP: sprint 97, CP: sprint 98, CP: sprint 99
    • 2
    • Core: Platform

    Description

      Extend resultInfo.schema with a new property that indicates whether totalRecords is an estimate or exact.

      Possible property names:

      • "isTotalRecordsEstimate"
      • "totalRecordsEstimated"
      • "totalRecordsAreEstimated"

      Core platform team decided to pick "totalRecordsEstimated" on 2020-07-27.

      True means that "totalRecords" is an estimated number, false means that "totalRecords" is the exact number, if omitted the exact count guarantee described on https://github.com/folio-org/raml-module-builder#estimated-totalrecords applies.

      https://github.com/folio-org/raml/blob/raml1.0/schemas/resultInfo.schema

      Note: it seems more appropriate to add it to resultInfo ONCE rather than doing it at as top-level element in response for each module.

      Example where "totalRecordsEstimated" has been added:

      {
  "instances": [
    { "id": "bf8812c6-4a2f-44f0-ac1f-ba2424cea00a", ... },
    { "id": "bfcefc83-4a2f-44f0-ac1f-ba2424cea48a", ...}
  ],
  "totalRecords": 2,
  "resultInfo" : {
    "totalRecords" : 2,
    "totalRecordsEstimated": false,
    "facets" : [ ]
  }
}

      TestRail: Results

        Attachments

          Issue Links

            defines

            New Feature - New feature requests UXPROD-2623 Wait for POC of Elastic Search - Round estimated search result hit count (totalRecords)

            • TBD - To be determined
            • Closed
            is blocked by

            Task - A task that needs to be done. RMB-695 Add totalRecordsEstimated and totalRecordsRounded to resultInfo.schema

            • P2 - normal priority level, must be included in the current development cycle
            • Closed
            is cloned by

            New Feature - New feature requests RMB-685 totalRecordsRounded

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Blocked
            relates to

            Task - A task that needs to be done. CHAL-243 Understand how/when CQL queries can be used to determine the number of records matching specified criteria

            • TBD - To be determined
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. MODINVSTOR-321 999 999 999 Records found

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Task - A task that needs to be done. RMB-506 estimate hit counts

            • TBD - To be determined
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. RMB-673 totalRecords returns exact hit count for limit=0

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. MODINVSTOR-468 hitcount related issues in Q1

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            New Feature - New feature requests RMB-579 In a GET request, control whether the server may estimate the hit count

            • TBD - To be determined
            • Closed

            Bug - A problem which impairs or prevents the functions of the product. UIORGS-197 End of list displays for search results before all records are loaded

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            New Feature - New feature requests UXPROD-2369 Wait for POC of Elastic Search - Implement exact hit count (when using PostgreSql)

            • TBD - To be determined
            • Closed

            Activity

              People

                julianladisch Julian Ladisch
                adam Adam Dickmeiss (Inactive)
                Votes:
                0 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                  Created:
                  Updated:

                  TestRail: Runs

                    TestRail: Cases