Get Object Count

The Object Count API provides a way to obtain the following values from the server:

• Number of objects in a table
• Number of objects matching query
• Number of related objects

Non-Blocking API

Using Java MapCustom Class

// get object count for all objects in the table
Backendless.Data.Of( "TABLE-NAME" ).GetObjectCount( AsyncCallback<int> callback );

// get object count for all objects in the table which match the query
Backendless.Data.Of( "TABLE-NAME" ).GetObjectCount( 
                                                   DataQueryBuilder queryBuilder,
                                                   AsyncCallback<int> callback );

// get object count for all objects in the table
Backendless.Data.Of( E ).GetObjectCount( AsyncCallback<int> callback );

// get object count for all objects in the table which match the query
Backendless.Data.Of( E ).GetObjectCount( DataQueryBuilder queryBuilder,
                                         AsyncCallback<int> callback );

Blocking API

Using DictionaryCustom Class

// get object count for all objects in the table
int Backendless.Data.Of( "TABLE-NAME" ).GetObjectCount();

// get object count for all objects in the table which match the query
int Backendless.Data.Of( "TABLE-NAME" ).GetObjectCount( DataQueryBuilder queryBuilder );

// get object count for all objects in the table
public int Backendless.Data.of( E ).getObjectCount();

// get object count for all objects in the table which match the query
public int Backendless.Data.of( E ).getObjectCount( DataQueryBuilder queryBuilder );

where:

Argument	Description
TABLE-NAME	Name of the table where to calculate the object count.
E	a .NET class which identifies the table where to calculate the object count.
queryBuilder	Instance of BackendlessAPI.Persistence.DataQueryBuilder. When present in the arguments, must contain a whereClause query. The query is used by the server to identify a collection of objects to calculate the count of.
callback	a callback object which will receive a callback when the method successfully calculates the object count. Applies to the non-blocking methods only.

Return Value

The blocking methods returns an integer value which is the object count. Non-blocking methods receive a callback with the count value.

Example

Total object count for a table:

The following sample request retrieves total number of objects in table Order:

Using DictionaryCustom Class

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );
Backendless.Data.Of( "Order" ).GetObjectCount( getCountCallback );

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );
Backendless.Data.Of<Order>().GetObjectCount( getCountCallback );

Object count for a query:

The following sample request retrieves total number of objects in table Order which satisfy the condition of orderAmount > 100:

Using DictionaryCustom Class

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );

DataQueryBuilder queryBuilder = DataQueryBuilder.Create();
queryBuilder.SetWhereClause( "orderAmount > 100" );
Backendless.Data.Of( "Order" ).GetObjectCount( queryBuilder, getCountCallback );

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );

DataQueryBuilder queryBuilder = DataQueryBuilder.Create();
queryBuilder.SetWhereClause( "orderAmount > 100" );
Backendless.Data.Of<Order>().GetObjectCount( queryBuilder, getCountCallback );

Related object count:

The following sample request retrieves total number of related "child" objects for a parent object. The parent table is Person. It contains a relation column called address pointing to the Addresstable. The query below retrieves a count of related child objects for a parent object with objectID of XXXX-XXXX-XXXX-XXXX. The whereClause query syntax for this scenario is:

Person[address].objectId = 'XXXX-XXXX-XXXX-XXXX'

Using DictionaryCustom Class

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );

DataQueryBuilder queryBuilder = DataQueryBuilder.Create();
queryBuilder.SetWhereClause( "Person[address].objectId = 'XXXX-XXXX-XXXX-XXXX'" );
Backendless.Data.Of( "Address" ).GetObjectCount( queryBuilder,
                                                 getCountCallback );

AsyncCallback<int> getCountCallback = new AsyncCallback<int>(
  objectCount => 
    {
      System.Console.WriteLine( "object count is " + objectCount );
    },
  error => 
    {
      System.Console.WriteLine( "Server returned an error " + error.Message );
    }
  );

DataQueryBuilder queryBuilder = DataQueryBuilder.Create();
queryBuilder.SetWhereClause( "Person[address].objectId = 'XXXX-XXXX-XXXX-XXXX'" );
Backendless.Data.Of<Address>().GetObjectCount( queryBuilder,
                                                  getCountCallback );

Codeless Reference

where:

Argument	Description
table name	Name of the data table where to calculate the object count.
where clause	Optional argument. If set, it is a search query used by the server it to determine the number of objects matching the condition. Refer to the Search With The Where Clause topic for more information.
distinct	Used to return unique objects from the data table. Only custom properties/columns are considered in the query. Hence, if the data table contains a duplicate object, then it is not counted in the operation.

Returns the number of objects in a table (if the where clause is not set), otherwise the number of objects matching the search query.

Consider the following records in the employees data table:

The example below counts specific objects in the data table since the where clause condition is set to exclude objects that contain the value 'Manager' in the column position. Thereby, objects with the 'Manager' values in the position column are not counted in the operation.

The result of this operation will look as shown below after the Codeless logic runs:

Consider the data table below that contains two duplicate objects:

The Codeless logic below has a where clause condition which is set to include in the operation only those objects that contain the value 'CEO' in the position column. The distinct parameter is set to true, hence the operation is set to count only unique objects, duplicates are skipped.

The result of this operation will look as shown below after the Codeless logic runs: