pjs.data.getCount()

Owned by Scot Roach
Last updated: Aug 16, 2023 by Jessica Tomkins
1 min read



This API is used to retrieve just the record count from a database object.

Parameters

  1. Database Connection Definition:
    (Object / Optional) - A database connection definition object returned from pjs.getDB(). If not passed, the default database connection will be used.


  2. Database Object:
    (String) Database object name. The name can be qualified with a library/schema. If not qualified the pathlist will be used to resolve the object.
    --or--
    (String) DbDefn file name (with the extension). The file can be qualified with a directory. If not qualified the pathlist will be used to resolve the object.
    --or--
    (Object) DbDefn instance.


  3. Filter:
    Single condition - created using pjs.data.createCondition API
    --or--
    Array of conditions - created using pjs.data.createCondition API
    --or--
    (String) – SQL syntax, because pjs.data.createCondition does support every possible way of conditioning

Exception Handling

An Error instance will be thrown along with these additional properties:

  • sqlstate - The error state.

  • sqlcode - The error code.

  • sqlMessage - The message text.



Examples
// This will get the total number of customers in the database let data_count1 = pjs.data.getCount("customers"); // This will get the total number of customers in the database that has customerName >= B let filter = pjs.data.createCondition("customerName", ">=", "B"); let data_count2 = pjs.data.getCount("customers", filter);